Skip to content

Commit

Permalink
docs(readme): fix headings [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed May 5, 2021
1 parent fd8f0e5 commit c97317c
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _readme:

postgres-formula
================

Expand Down Expand Up @@ -63,7 +61,7 @@ Creates such DB objects as: users, tablespaces, databases, schemas and extension
See ``pillar.example`` file for details.

``postgres.python``
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^

Installs the PostgreSQL adapter for Python on Linux.

Expand Down Expand Up @@ -119,17 +117,17 @@ Removal states
Meta state to remove Postgres software. By default the release installed by formula is targeted only. To target multiple releases, set pillar ``postgres.remove.multiple_releases: True``.

``postgres.server.remove``
^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^

Remove server, lib, and contrib packages. The ``postgres.server.remove`` will retain data by default (no data loss) - set pillar ``postgres.remove.data: True`` to remove data and configuration directories also.

``postgres.client.remove``
^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^

Remove client package.

``postgres.dev.remove``
^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^

Remove development and python packages.

Expand All @@ -150,7 +148,7 @@ Creates the docker instance and runs the ``postgres`` main state, ready for test
Runs the ``inspec`` tests on the actual instance.

``kitchen destroy``
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^

Removes the docker instance.

Expand Down

0 comments on commit c97317c

Please sign in to comment.