From 87a2a63144e84410310538fb0a3dbd9830f1bc2a Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 27 Apr 2018 13:03:09 -0400 Subject: [PATCH] Deduplicate config/policy reference docs from main index The top level index (home page) was duplicating the configuration/index content, so this simply changes the home page into a table of contents for the configuration sub-tree and leaves the config/policy content in the sub-tree. This will be needed when we add docs about placement policy. The hidden configuration toc tree items are moved into the sub-tree configuration/index to be closer to the actual documents we're hiding from the toc tree. Related to blueprint granular-placement-policy Change-Id: Iad87dc339278ee7e7cf8de5eea252bbb7a5f75c2 --- doc/source/configuration/index.rst | 20 ++++++++++++++++---- doc/source/index.rst | 27 ++------------------------- 2 files changed, 18 insertions(+), 29 deletions(-) diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 3698deb75..66081dcbf 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -14,10 +14,10 @@ Configuration configuration guides for various parts of you Nova system. Helpful reference for setting up specific hypervisor backends. -* :doc:`Config Reference `: A complete reference of all +* :doc:`Config Reference `: A complete reference of all configuration options available in the ``nova.conf`` file. -* :doc:`Sample Config File `: A sample config +* :doc:`Sample Config File `: A sample config file with inline documentation. Policy @@ -26,8 +26,20 @@ Policy Nova, like most OpenStack projects, uses a policy language to restrict permissions on REST API actions. -* :doc:`Policy Reference `: A complete reference of all +* :doc:`Policy Reference `: A complete reference of all policy points in nova and what they impact. -* :doc:`Sample Policy File `: A sample policy +* :doc:`Sample Policy File `: A sample policy file with inline documentation. + + +.. # NOTE(mriedem): This is the section where we hide things that we don't + # actually want in the table of contents but sphinx build would fail if + # they aren't in the toctree somewhere. +.. toctree:: + :hidden: + + config + sample-config + policy + sample-policy diff --git a/doc/source/index.rst b/doc/source/index.rst index 5600286dc..fec5c4b27 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -180,27 +180,8 @@ Reference Material * :doc:`Nova CLI Command References `: the complete command reference for all the daemons and admin tools that come with nova. - -* **Configuration**: - - * :doc:`Configuration Guide `: detailed - configuration guides for various parts of you Nova system. Helpful - reference for setting up specific hypervisor backends. - - * :doc:`Config Reference `: a complete reference of all - configuration options available in the nova.conf file. - - * :doc:`Sample Config File `: a sample config file - with inline documentation. - -* **Policy**: nova, like most OpenStack projects, uses a policy language to - restrict permissions on REST API actions. - - * :doc:`Policy Reference `: a complete reference of all - policy points in nova and what they impact. - - * :doc:`Sample Policy File `: a sample policy file - with inline documentation. +* :doc:`Configuration Guide `: Information on configuring + the system, including role-based access control policy rules. For Contributors ================ @@ -233,10 +214,6 @@ looking parts of our architecture. These are collected below. admin/configuration/index cli/index configuration/index - configuration/config - configuration/sample-config - configuration/policy - configuration/sample-policy contributor/development-environment contributor/api contributor/api-2