diff --git a/doc/source/index.rst b/doc/source/index.rst index 618f93f..53f3708 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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/* diff --git a/specs/approved/.gitkeep b/specs/1.x/approved/.gitkeep similarity index 100% rename from specs/approved/.gitkeep rename to specs/1.x/approved/.gitkeep diff --git a/specs/approved/airship_copilot_gui.rst b/specs/1.x/approved/airship_copilot_gui.rst similarity index 100% rename from specs/approved/airship_copilot_gui.rst rename to specs/1.x/approved/airship_copilot_gui.rst diff --git a/specs/approved/airship_multi_linux_distros.rst b/specs/1.x/approved/airship_multi_linux_distros.rst similarity index 100% rename from specs/approved/airship_multi_linux_distros.rst rename to specs/1.x/approved/airship_multi_linux_distros.rst diff --git a/specs/approved/data_config_generator.rst b/specs/1.x/approved/data_config_generator.rst similarity index 100% rename from specs/approved/data_config_generator.rst rename to specs/1.x/approved/data_config_generator.rst diff --git a/specs/approved/divingbell_ansible_framework.rst b/specs/1.x/approved/divingbell_ansible_framework.rst similarity index 100% rename from specs/approved/divingbell_ansible_framework.rst rename to specs/1.x/approved/divingbell_ansible_framework.rst diff --git a/specs/approved/drydock_add_redfish_as_oob_driver.rst b/specs/1.x/approved/drydock_add_redfish_as_oob_driver.rst similarity index 100% rename from specs/approved/drydock_add_redfish_as_oob_driver.rst rename to specs/1.x/approved/drydock_add_redfish_as_oob_driver.rst diff --git a/specs/approved/drydock_support_bios_configuration.rst b/specs/1.x/approved/drydock_support_bios_configuration.rst similarity index 100% rename from specs/approved/drydock_support_bios_configuration.rst rename to specs/1.x/approved/drydock_support_bios_configuration.rst diff --git a/specs/approved/k8s_external_facing_api.rst b/specs/1.x/approved/k8s_external_facing_api.rst similarity index 100% rename from specs/approved/k8s_external_facing_api.rst rename to specs/1.x/approved/k8s_external_facing_api.rst diff --git a/specs/approved/k8s_update_node_labels_workflow.rst b/specs/1.x/approved/k8s_update_node_labels_workflow.rst similarity index 100% rename from specs/approved/k8s_update_node_labels_workflow.rst rename to specs/1.x/approved/k8s_update_node_labels_workflow.rst diff --git a/specs/approved/pegleg_secrets.rst b/specs/1.x/approved/pegleg_secrets.rst similarity index 100% rename from specs/approved/pegleg_secrets.rst rename to specs/1.x/approved/pegleg_secrets.rst diff --git a/specs/approved/workflow_node-teardown.rst b/specs/1.x/approved/workflow_node-teardown.rst similarity index 100% rename from specs/approved/workflow_node-teardown.rst rename to specs/1.x/approved/workflow_node-teardown.rst diff --git a/specs/implemented/.gitkeep b/specs/1.x/implemented/.gitkeep similarity index 100% rename from specs/implemented/.gitkeep rename to specs/1.x/implemented/.gitkeep diff --git a/specs/implemented/deployment-grouping-baremetal.rst b/specs/1.x/implemented/deployment-grouping-baremetal.rst similarity index 100% rename from specs/implemented/deployment-grouping-baremetal.rst rename to specs/1.x/implemented/deployment-grouping-baremetal.rst diff --git a/specs/2.x/approved/.gitkeep b/specs/2.x/approved/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/specs/2.x/approved/index.rst b/specs/2.x/approved/index.rst new file mode 100644 index 0000000..a705d15 --- /dev/null +++ b/specs/2.x/approved/index.rst @@ -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. diff --git a/specs/2.x/implemented/.gitkeep b/specs/2.x/implemented/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/specs/2.x/implemented/index.rst b/specs/2.x/implemented/index.rst new file mode 100644 index 0000000..a705d15 --- /dev/null +++ b/specs/2.x/implemented/index.rst @@ -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. diff --git a/specs/instructions.rst b/specs/instructions.rst index a76051b..1b1e2c7 100644 --- a/specs/instructions.rst +++ b/specs/instructions.rst @@ -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 ---------------------------