Split 1.x and 2.x Specs to separate directories
Change-Id: I25d4778b79a2bd55f6f14d8bfeed81232898e33d
This commit is contained in:
parent
987eacad79
commit
02047a1674
@ -17,20 +17,44 @@ About Specs
|
||||
|
||||
specs/*
|
||||
|
||||
Airship 2.x
|
||||
-----------
|
||||
|
||||
Approved Specs
|
||||
--------------
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/approved/*
|
||||
specs/2.x/approved/*
|
||||
|
||||
Implemented Specs
|
||||
-----------------
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/implemented/*
|
||||
specs/2.x/implemented/*
|
||||
|
||||
Airship 1.x
|
||||
-----------
|
||||
|
||||
Approved Specs
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/1.x/approved/*
|
||||
|
||||
Implemented Specs
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
specs/1.x/implemented/*
|
||||
|
0
specs/2.x/approved/.gitkeep
Normal file
0
specs/2.x/approved/.gitkeep
Normal file
18
specs/2.x/approved/index.rst
Normal file
18
specs/2.x/approved/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
.. index::
|
||||
single: Airship
|
||||
single: Shipyard
|
||||
single: GUI
|
||||
single: CLI
|
||||
single: API
|
||||
|
||||
===========
|
||||
Placeholder
|
||||
===========
|
||||
|
||||
Please, remove me once any new spec is added into this directory.
|
0
specs/2.x/implemented/.gitkeep
Normal file
0
specs/2.x/implemented/.gitkeep
Normal file
18
specs/2.x/implemented/index.rst
Normal file
18
specs/2.x/implemented/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
.. index::
|
||||
single: Airship
|
||||
single: Shipyard
|
||||
single: GUI
|
||||
single: CLI
|
||||
single: API
|
||||
|
||||
===========
|
||||
Placeholder
|
||||
===========
|
||||
|
||||
Please, remove me once any new spec is added into this directory.
|
@ -18,8 +18,9 @@ Instructions
|
||||
- Attempt to detail each applicable section.
|
||||
- If a section does not apply, use N/A, and optionally provide
|
||||
a short explanation.
|
||||
- New specs for review should be placed in the ``approved`` subfolder, where
|
||||
they will undergo review and approval in Gerrit_.
|
||||
- New specs for review should be placed in the ``approved`` subfolder of
|
||||
``1.x`` or ``2.x`` directories (depending on Airship version they primarily
|
||||
belong to), where they will undergo review and approval in Gerrit_.
|
||||
- Test if the spec file renders correctly in a web-browser by running
|
||||
``make docs`` command and opening ``doc/build/html/index.html`` in a
|
||||
web-browser. Ubuntu needs the following packages to be installed::
|
||||
@ -27,7 +28,7 @@ Instructions
|
||||
apt-get install -y make tox gcc python3-dev
|
||||
|
||||
- Specs that have finished implementation should be moved to the
|
||||
``implemented`` subfolder.
|
||||
``implemented`` subfolder of respective ``1.x`` or ``2.x`` directories.
|
||||
|
||||
Indexing and Categorization
|
||||
---------------------------
|
||||
|
Loading…
Reference in New Issue
Block a user