openinfra
/
interop
Code Issues Proposed changes

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
This commit is contained in:
Mark T. Voelker 2015-07-15 17:31:24 -07:00
parent 180a348ab1
commit 3b2523a621
5 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.rst
View File

@ -11,16 +11,19 @@ NOTE: Changes to file requires approval of the DefCore committee chair(s).
DefCore Process Documentation 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 The /doc/source/schema directory contains details about the JSON schema
express Guidelines. versions used to express Guidelines.
:Core Definition: process/CoreDefinition.rst The /doc/source/guidelines directory contains RST versions of the DefCore
:Process Goverance: process/2015A.rst (please check for latest) Guidelines approved by the OpenStack Board of Directors.
:Designated Sections: process/DesignatedSections.rst
:Core Criteria: process/CoreCriteria.rst :Core Definition: doc/source/process/CoreDefinition.rst
:DefCore Governance: process/GovernanceProcess.rst :Process Goverance: doc/source/process/2015A.rst (please check for latest)
:Platform and Components: process/PlatformCap.rst :Designated Sections: doc/source/process/DesignatedSections.rst
:DefCore Cycles: process/ProcessCycles.rst :Core Criteria: doc/source/process/CoreCriteria.rst
:Terminology: process/Lexicon.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

0
2015.03.rst → doc/source/guidelines/2015.03.rst
View File

0
2015.04.rst → doc/source/guidelines/2015.04.rst
View File

0
2015.05.rst → doc/source/guidelines/2015.05.rst
View File

10
doc/source/index.rst
View File

@ -21,3 +21,13 @@ Schema Documentation
:maxdepth: 1 :maxdepth: 1
schema/* schema/*
==========
Guidelines
==========
.. toctree::
:glob:
:maxdepth: 1
guidelines/*