From 3b2523a62179f2c052cbc99fced5ef331a4cc01b Mon Sep 17 00:00:00 2001 From: "Mark T. Voelker" Date: Wed, 15 Jul 2015 17:31:24 -0700 Subject: [PATCH] Move Guidelines into doc directory As we add more and more Guidelines over time, the top-level directory of the defcore repo is becoming increasingly cluttered. Further, each Guideline includes an RST file that could be rendered on docs.openstack.org and/or gate-checked for validity like other RST documents. This patch moves the Guideline docs into a dedicated folder in the doc directory using a structure akin to that of the process docs that already reside there. [1][2] It also cleans up a few references to documents already in the doc directory that were missed earlier, and adds a note to the README indicating what the doc/sources/guidelines directory contains. Note that a few links on http://openstack.org/interop and DefCore wiki pages may need to be updated if/when this change lands. It is therefore suggested that this patch be merged only when the relevant Foundation staff are prepared to make corresponding updates to the website in order to avoid broken links. [1] https://review.openstack.org/#/c/189950/ [2] https://review.openstack.org/#/c/189956/ Change-Id: Iddd8a4c191c490f4b0afb8c88c8520da4b97576b --- README.rst | 25 +++++++++++-------- .../source/guidelines/2015.03.rst | 0 .../source/guidelines/2015.04.rst | 0 .../source/guidelines/2015.05.rst | 0 doc/source/index.rst | 10 ++++++++ 5 files changed, 24 insertions(+), 11 deletions(-) rename 2015.03.rst => doc/source/guidelines/2015.03.rst (100%) rename 2015.04.rst => doc/source/guidelines/2015.04.rst (100%) rename 2015.05.rst => doc/source/guidelines/2015.05.rst (100%) diff --git a/README.rst b/README.rst index 4881ea25..5b04ec5c 100644 --- a/README.rst +++ b/README.rst @@ -11,16 +11,19 @@ NOTE: Changes to file requires approval of the DefCore committee chair(s). DefCore Process Documentation ============================= -The /process directory contains details about the DefCore process. +The /doc/source/process directory contains details about the DefCore process. -The /schema directory contains details about the JSON schema versions used to -express Guidelines. +The /doc/source/schema directory contains details about the JSON schema +versions used to express Guidelines. -:Core Definition: process/CoreDefinition.rst -:Process Goverance: process/2015A.rst (please check for latest) -:Designated Sections: process/DesignatedSections.rst -:Core Criteria: process/CoreCriteria.rst -:DefCore Governance: process/GovernanceProcess.rst -:Platform and Components: process/PlatformCap.rst -:DefCore Cycles: process/ProcessCycles.rst -:Terminology: process/Lexicon.rst +The /doc/source/guidelines directory contains RST versions of the DefCore +Guidelines approved by the OpenStack Board of Directors. + +:Core Definition: doc/source/process/CoreDefinition.rst +:Process Goverance: doc/source/process/2015A.rst (please check for latest) +:Designated Sections: doc/source/process/DesignatedSections.rst +:Core Criteria: doc/source/process/CoreCriteria.rst +:DefCore Governance: doc/source/process/GovernanceProcess.rst +:Platform and Components: doc/source/process/PlatformCap.rst +:DefCore Cycles: doc/source/process/ProcessCycles.rst +:Terminology: doc/source/process/Lexicon.rst diff --git a/2015.03.rst b/doc/source/guidelines/2015.03.rst similarity index 100% rename from 2015.03.rst rename to doc/source/guidelines/2015.03.rst diff --git a/2015.04.rst b/doc/source/guidelines/2015.04.rst similarity index 100% rename from 2015.04.rst rename to doc/source/guidelines/2015.04.rst diff --git a/2015.05.rst b/doc/source/guidelines/2015.05.rst similarity index 100% rename from 2015.05.rst rename to doc/source/guidelines/2015.05.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 64c3e31f..35386aea 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,3 +21,13 @@ Schema Documentation :maxdepth: 1 schema/* + +========== +Guidelines +========== + +.. toctree:: + :glob: + :maxdepth: 1 + + guidelines/*