Adds docs on how to view settings.

This PR also moves the configuration to its own section and out of the installer section. The configuration has too much content to be in its own section anymore (I think). closes #6235
pulp · May 19, 2021 · 0346b52 · 0346b52
1 parent 39bdca5
commit 0346b52
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 5 deletions.
diff --git a/CHANGES/6235.doc b/CHANGES/6235.doc
@@ -0,0 +1 @@
+Added docs on how to list the effective settings using ``dyanconf list``.
diff --git a/docs/installation/configuration.rst → docs/configuration/applying.rst b/docs/installation/configuration.rst → docs/configuration/applying.rst
@@ -1,7 +1,7 @@
-.. _configuration:
+.. _applying-settings:
 
-Configuration
-=============
+Applying Settings
+=================
 
 Pulp uses `dynaconf <https://dynaconf.readthedocs.io/en/latest/>`_ for its settings which allows you
 to configure Pulp in a few ways:

diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst
@@ -0,0 +1,11 @@
+.. _configuration:
+
+Configuration
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   applying
+   viewing
+   settings
diff --git a/docs/settings.rst → docs/configuration/settings.rst b/docs/settings.rst → docs/configuration/settings.rst
diff --git a/docs/configuration/viewing.rst b/docs/configuration/viewing.rst
@@ -0,0 +1,11 @@
+.. viewing-settings:
+
+Viewing Settings
+================
+
+To list the effective settings on a Pulp installation, while on the system where Pulp is installed
+run the command ``dynaconf list``. This will show the effective settings Pulp will use.
+
+Note that settings can come from both settings file and environment variables, so when running the
+``dynaconf list`` command be sure you have the same environment variables set as your Pulp
+installation.
diff --git a/docs/index.rst b/docs/index.rst
@@ -65,7 +65,7 @@ Table of Contents
    from-pulp-2
    components
    installation/index
-   settings
+   configuration/index
    workflows/index
    plugins/index
    rest_api

diff --git a/docs/installation/index.rst b/docs/installation/index.rst
@@ -7,7 +7,6 @@ Installation
    :maxdepth: 2
 
    instructions
-   configuration
    storage
    authentication