karel/postgres-formula
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): fix headings [skip ci]

Browse Source
This commit is contained in:
Imran Iqbal
2021-05-05 15:16:30 +01:00
parent fd8f0e5db5
commit c97317c39f
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.rst
View File

@@ -1,5 +1,3 @@
.. _readme:
postgres-formula postgres-formula
================ ================
@@ -63,7 +61,7 @@ Creates such DB objects as: users, tablespaces, databases, schemas and extension
See ``pillar.example`` file for details. See ``pillar.example`` file for details.
``postgres.python`` ``postgres.python``
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Installs the PostgreSQL adapter for Python on Linux. Installs the PostgreSQL adapter for Python on Linux.
@@ -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``. 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`` ``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. 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`` ``postgres.client.remove``
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove client package. Remove client package.
``postgres.dev.remove`` ``postgres.dev.remove``
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Remove development and python packages. Remove development and python packages.
@@ -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. Runs the ``inspec`` tests on the actual instance.
``kitchen destroy`` ``kitchen destroy``
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
Removes the docker instance. Removes the docker instance.