Browse Source

Split 1.x and 2.x Specs to separate directories

Change-Id: I25d4778b79a2bd55f6f14d8bfeed81232898e33d
changes/19/681519/2
Roman Gorshunov 2 years ago
parent
commit
02047a1674
19 changed files with 68 additions and 7 deletions
  1. +28
    -4
      doc/source/index.rst
  2. +0
    -0
      specs/1.x/approved/.gitkeep
  3. +0
    -0
      specs/1.x/approved/airship_copilot_gui.rst
  4. +0
    -0
      specs/1.x/approved/airship_multi_linux_distros.rst
  5. +0
    -0
      specs/1.x/approved/data_config_generator.rst
  6. +0
    -0
      specs/1.x/approved/divingbell_ansible_framework.rst
  7. +0
    -0
      specs/1.x/approved/drydock_add_redfish_as_oob_driver.rst
  8. +0
    -0
      specs/1.x/approved/drydock_support_bios_configuration.rst
  9. +0
    -0
      specs/1.x/approved/k8s_external_facing_api.rst
  10. +0
    -0
      specs/1.x/approved/k8s_update_node_labels_workflow.rst
  11. +0
    -0
      specs/1.x/approved/pegleg_secrets.rst
  12. +0
    -0
      specs/1.x/approved/workflow_node-teardown.rst
  13. +0
    -0
      specs/1.x/implemented/.gitkeep
  14. +0
    -0
      specs/1.x/implemented/deployment-grouping-baremetal.rst
  15. +0
    -0
      specs/2.x/approved/.gitkeep
  16. +18
    -0
      specs/2.x/approved/index.rst
  17. +0
    -0
      specs/2.x/implemented/.gitkeep
  18. +18
    -0
      specs/2.x/implemented/index.rst
  19. +4
    -3
      specs/instructions.rst

+ 28
- 4
doc/source/index.rst View File

@ -17,20 +17,44 @@ About Specs
specs/*
Airship 2.x
-----------
Approved Specs
~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
:glob:
specs/2.x/approved/*
Implemented Specs
~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
:glob:
specs/2.x/implemented/*
Airship 1.x
-----------
Approved Specs
--------------
~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
:glob:
specs/approved/*
specs/1.x/approved/*
Implemented Specs
-----------------
~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
:glob:
specs/implemented/*
specs/1.x/implemented/*

specs/approved/.gitkeep → specs/1.x/approved/.gitkeep View File


specs/approved/airship_copilot_gui.rst → specs/1.x/approved/airship_copilot_gui.rst View File


specs/approved/airship_multi_linux_distros.rst → specs/1.x/approved/airship_multi_linux_distros.rst View File


specs/approved/data_config_generator.rst → specs/1.x/approved/data_config_generator.rst View File


specs/approved/divingbell_ansible_framework.rst → specs/1.x/approved/divingbell_ansible_framework.rst View File


specs/approved/drydock_add_redfish_as_oob_driver.rst → specs/1.x/approved/drydock_add_redfish_as_oob_driver.rst View File


specs/approved/drydock_support_bios_configuration.rst → specs/1.x/approved/drydock_support_bios_configuration.rst View File


specs/approved/k8s_external_facing_api.rst → specs/1.x/approved/k8s_external_facing_api.rst View File


specs/approved/k8s_update_node_labels_workflow.rst → specs/1.x/approved/k8s_update_node_labels_workflow.rst View File


specs/approved/pegleg_secrets.rst → specs/1.x/approved/pegleg_secrets.rst View File


specs/approved/workflow_node-teardown.rst → specs/1.x/approved/workflow_node-teardown.rst View File


specs/implemented/.gitkeep → specs/1.x/implemented/.gitkeep View File


specs/implemented/deployment-grouping-baremetal.rst → specs/1.x/implemented/deployment-grouping-baremetal.rst View File


+ 0
- 0
specs/2.x/approved/.gitkeep View File


+ 18
- 0
specs/2.x/approved/index.rst View 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
- 0
specs/2.x/implemented/.gitkeep View File


+ 18
- 0
specs/2.x/implemented/index.rst View 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.

+ 4
- 3
specs/instructions.rst View File

@ -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…
Cancel
Save