From 18be5324d6c1dfde54a1a1f8abc8b32f09e45a54 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 27 Jun 2017 11:07:24 +0100 Subject: [PATCH] doc: Populate the 'configuration' section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per the spec [1]: configuration/ – automatically generated configuration reference information based on oslo.config’s sphinx integration (or manually written for projects not using oslo.config). Step-by-step guides for doing things like enabling cells or configuring a specific driver should be placed in the admin/ section. Only the 'sample_policy' and 'sample_config' files fit into this category at present. We may wish to add files that use the oslo.config and oslo.policy Sphinx integrations, but that can come later. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I587551ada1932876bca51a362f8dfeef6f7dd70b --- .../{sample_config.rst => configuration/sample-config.rst} | 5 +++-- .../{sample_policy.rst => configuration/sample-policy.rst} | 6 +++--- doc/source/index.rst | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) rename doc/source/{sample_config.rst => configuration/sample-config.rst} (70%) rename doc/source/{sample_policy.rst => configuration/sample-policy.rst} (61%) diff --git a/doc/source/sample_config.rst b/doc/source/configuration/sample-config.rst similarity index 70% rename from doc/source/sample_config.rst rename to doc/source/configuration/sample-config.rst index ae8e6f17bf26..54b1bd1fdb7d 100644 --- a/doc/source/sample_config.rst +++ b/doc/source/configuration/sample-config.rst @@ -7,6 +7,7 @@ auto-generated from Nova when this documentation is built, so if you are having issues with an option, please compare your version of Nova with the version of this documentation. -The sample configuration can also be viewed in `file form <_static/nova.conf.sample>`_. +The sample configuration can also be viewed in :download:`file form +`. -.. literalinclude:: _static/nova.conf.sample +.. literalinclude:: /_static/nova.conf.sample diff --git a/doc/source/sample_policy.rst b/doc/source/configuration/sample-policy.rst similarity index 61% rename from doc/source/sample_policy.rst rename to doc/source/configuration/sample-policy.rst index dba4d27abcb1..acf67dfb626b 100644 --- a/doc/source/sample_policy.rst +++ b/doc/source/configuration/sample-policy.rst @@ -6,7 +6,7 @@ The following is a sample nova policy file, autogenerated from nova when this documentation is built. To prevent conflicts, ensure your version of nova aligns with the version of this documentation. -The sample policy can also be viewed in `file form -<_static/nova.policy.yaml.sample>`_. +The sample policy can also be viewed in :download:`file form +`. -.. literalinclude:: _static/nova.policy.yaml.sample +.. literalinclude:: /_static/nova.policy.yaml.sample diff --git a/doc/source/index.rst b/doc/source/index.rst index 4dcd5466e4d4..1327dee5ca6a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -199,7 +199,7 @@ Sample Configuration File .. toctree:: :maxdepth: 1 - sample_config + configuration/sample-config Sample Policy file ------------------ @@ -207,7 +207,7 @@ Sample Policy file .. toctree:: :maxdepth: 1 - sample_policy + configuration/sample-policy Man Pages ----------