From 32bed9e1c8257d2c55c0de3db97800ea28891583 Mon Sep 17 00:00:00 2001 From: Chris Hoge Date: Sun, 10 May 2015 12:42:16 -0700 Subject: [PATCH] Update tox.ini to test all rst, fix tox errors Updated tox.ini to check current rst documents. Fixed tox errors in checked documents. Semantics of docments remained unchanged Change-Id: Ic4b628b551e0c438ca71d5728afa7172bc3cf128 --- README.rst | 3 ++- process/2015A.rst | 46 ++++++++++++++++++---------------- process/DesignatedSections.rst | 4 ++- process/GovernanceProcess.rst | 2 +- process/Lexicon.rst | 4 +-- process/ProcessCycles.rst | 4 +-- test-requirements.txt | 1 + tox.ini | 3 +-- 8 files changed, 36 insertions(+), 31 deletions(-) diff --git a/README.rst b/README.rst index fb0873c2..4881ea25 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,8 @@ Understanding the DefCore Guidelines ================================================= -This repository contains DefCore committee managed files that provide guidance for the OpenStack community. +This repository contains DefCore committee managed files that provide guidance +for the OpenStack community. NOTE: Changes to file requires approval of the DefCore committee chair(s). diff --git a/process/2015A.rst b/process/2015A.rst index bc563938..1c18c95b 100644 --- a/process/2015A.rst +++ b/process/2015A.rst @@ -10,25 +10,25 @@ bylaws and approved by the OpenStack Technical Committee and Board. Expected Time line: --------------------------------------- -+------------+-----------+------------------------------------+-----------+ -| Time Frame | Milestone | Activities | Lead By | -+============+===========+====================================+===========+ -| -3 months | S-3 | "Preliminary” draft (from current) | DefCore | -+------------+-----------+------------------------------------+-----------+ -| -2 months | S-2 | ID new Capabilities | Community | -+------------+-----------+------------------------------------+-----------+ -| -1 month | S-1 | Score Capabilities | DefCore | -+------------+-----------+------------------------------------+-----------+ -| Summit | S | "Solid" draft | Community | -+ + +------------------------------------+-----------+ -| | | Advisory/Deprecated items selected | DefCore | -+------------+-----------+------------------------------------+-----------+ -| +1 month | S+1 | Self-testing | Vendors | -+------------+-----------+------------------------------------+-----------+ -| +2 months | S+2 | Test Flagging | DefCore | -+------------+-----------+------------------------------------+-----------+ -| +3 months | S+3 | Approve Guidance | Board | -+------------+-----------+------------------------------------+-----------+ ++------------+-----------+--------------------------------------+-----------+ +| Time Frame | Milestone | Activities | Lead By | ++============+===========+======================================+===========+ +| -3 months | S-3 | \"Preliminary\" draft (from current) | DefCore | ++------------+-----------+--------------------------------------+-----------+ +| -2 months | S-2 | ID new Capabilities | Community | ++------------+-----------+--------------------------------------+-----------+ +| -1 month | S-1 | Score Capabilities | DefCore | ++------------+-----------+--------------------------------------+-----------+ +| Summit | S | \"Solid\" draft | Community | ++ + +--------------------------------------+-----------+ +| | | Advisory/Deprecated items selected | DefCore | ++------------+-----------+--------------------------------------+-----------+ +| +1 month | S+1 | Self-testing | Vendors | ++------------+-----------+--------------------------------------+-----------+ +| +2 months | S+2 | Test Flagging | DefCore | ++------------+-----------+--------------------------------------+-----------+ +| +3 months | S+3 | Approve Guidance | Board | ++------------+-----------+--------------------------------------+-----------+ Note: DefCore may accelerate the process to correct errors and omissions. @@ -113,7 +113,8 @@ A4. DefCore Committee identifies required capabilities 6. Capabilities will not be added without being advisory in the previous Guideline. -A5. Foundation Staff recommends OpenStack Components and OpenStack Platform Scope +A5. Foundation Staff recommends OpenStack Components and OpenStack Platform + Scope 1. Foundation Staff recommends capabilities to include in each OpenStack Component. @@ -244,9 +245,10 @@ D1. Board will review and approve DefCore Guideline from draft D2. DefCore Committee has authority on test categorization - 1. DefCore Committee can add flagged tests before and after Guideline approval. - 2. DefCore Committee cannot add additional Tests to Capability mappings after + 1. DefCore Committee can add flagged tests before and after Guideline approval. + 2. DefCore Committee cannot add additional Tests to Capability mappings + after approval. 3. DefCore Committee maintains the test to capability mappings in the JSON representation. diff --git a/process/DesignatedSections.rst b/process/DesignatedSections.rst index 619afae0..d56918bf 100644 --- a/process/DesignatedSections.rst +++ b/process/DesignatedSections.rst @@ -16,7 +16,9 @@ Designated Sections Selection Guidance _Approved 2014 Dec 2_ -There DefCore committee identified 10 selection criteria. The first seven are technical from the TC and last three allow the Board to resolve issues without needed a technical judgement. +There DefCore committee identified 10 selection criteria. The first seven are +technical from the TC and last three allow the Board to resolve issues without +needed a technical judgement. 1. Designated if the code provides the project external REST API diff --git a/process/GovernanceProcess.rst b/process/GovernanceProcess.rst index 73ae29ee..508c2018 100644 --- a/process/GovernanceProcess.rst +++ b/process/GovernanceProcess.rst @@ -13,6 +13,6 @@ Governance Process `_. * Process documents and other "rules of the road" will be maintained and - voted on in `Gerrit + voted on in `Gerrit `_. Committee chairs will have +/-2 voting privilleges. diff --git a/process/Lexicon.rst b/process/Lexicon.rst index bb1ab66d..09719b78 100644 --- a/process/Lexicon.rst +++ b/process/Lexicon.rst @@ -64,7 +64,7 @@ Designated Sections intended by the project maintainers to be replaceable, extend the project REST API in a new or different way, or code that is being deprecated. - + Flagged Test A test that does not provide consistent results in the field and it not required for vendor self-test. @@ -89,7 +89,7 @@ Participant Platform The collection of components required to use the least restricted mark. -Self-test +Self-test Process by which a vendor runs tests against their product or service without 3rd party observation. diff --git a/process/ProcessCycles.rst b/process/ProcessCycles.rst index aa1cbe5c..b8b2f1f3 100644 --- a/process/ProcessCycles.rst +++ b/process/ProcessCycles.rst @@ -31,7 +31,7 @@ Objectives * Establish the "must-pass" tests, processes and tools * Define tests that will be used to determine core based on Spider -cycle work + cycle work * Lower the water in the discussion to expose broader issues @@ -55,7 +55,7 @@ Objectives ~~~~~~~~~~ * Complete Capabilities Score for Havana (Advisory), Icehouse and -Juno + Juno * Recommend by-laws changes for winter voting diff --git a/test-requirements.txt b/test-requirements.txt index 6c6cb639..77e11877 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1 +1,2 @@ +pygments doc8 diff --git a/tox.ini b/tox.ini index 3ec3e9c0..55b81cd3 100644 --- a/tox.ini +++ b/tox.ini @@ -10,5 +10,4 @@ deps = -r{toxinidir}/test-requirements.txt [testenv:doc8] commands = - doc8 -e .rst 2015.03.rst 2015.04.rst 2015.next.rst CoreDefinition.rst \ - GovernanceProcess.rst ProcessCycles.rst README.rst lexicon.rst + doc8 *.rst **/*.rst