From 6e48d31a72ebf2e4fa1c9ca07d202e81c9ec5499 Mon Sep 17 00:00:00 2001 From: Madhuri Kumari Date: Tue, 11 Jul 2017 11:12:11 +0530 Subject: [PATCH] Move the contributor related docs to contributor/ dir Change-Id: I79d168e60758722af4c9c4a0df69efb1728e3bd6 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Partial-Bug: #1703442 --- doc/source/api_microversion_history.rst | 1 - doc/source/conf.py | 0 .../api-microversion.rst} | 0 doc/source/{ => contributor}/contributing.rst | 2 +- doc/source/contributor/index.rst | 31 +++++++++++++++++++ .../{dev => contributor}/manual-devstack.rst | 0 .../mod-wsgi.rst} | 0 doc/source/{ => contributor}/objects.rst | 0 .../{dev => contributor}/quickstart.rst | 0 .../tempest-tests.rst} | 0 .../unit-tests.rst} | 0 doc/source/{ => contributor}/usage.rst | 0 doc/source/index.rst | 25 +++++++-------- doc/source/installation.rst | 12 ------- doc/source/readme.rst | 1 - 15 files changed, 43 insertions(+), 29 deletions(-) delete mode 100644 doc/source/api_microversion_history.rst mode change 100755 => 100644 doc/source/conf.py rename doc/source/{dev/api_microversion.rst => contributor/api-microversion.rst} (100%) rename doc/source/{ => contributor}/contributing.rst (50%) create mode 100644 doc/source/contributor/index.rst rename doc/source/{dev => contributor}/manual-devstack.rst (100%) rename doc/source/{mod_wsgi.rst => contributor/mod-wsgi.rst} (100%) rename doc/source/{ => contributor}/objects.rst (100%) rename doc/source/{dev => contributor}/quickstart.rst (100%) rename doc/source/{dev/tempest_tests.rst => contributor/tempest-tests.rst} (100%) rename doc/source/{dev/unit_tests.rst => contributor/unit-tests.rst} (100%) rename doc/source/{ => contributor}/usage.rst (100%) delete mode 100644 doc/source/installation.rst delete mode 100644 doc/source/readme.rst diff --git a/doc/source/api_microversion_history.rst b/doc/source/api_microversion_history.rst deleted file mode 100644 index 39703b580..000000000 --- a/doc/source/api_microversion_history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../zun/api/rest_api_version_history.rst diff --git a/doc/source/conf.py b/doc/source/conf.py old mode 100755 new mode 100644 diff --git a/doc/source/dev/api_microversion.rst b/doc/source/contributor/api-microversion.rst similarity index 100% rename from doc/source/dev/api_microversion.rst rename to doc/source/contributor/api-microversion.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index 1728a61ca..2aa070771 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -1,4 +1,4 @@ ============ Contributing ============ -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..93d420802 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,31 @@ +Contributor's Guide +=================== + +If you are new to Zun, this section contains information that should help +you quickly get started. + +.. toctree:: + :maxdepth: 1 + + Setting Up Your Development Environment + +There are documents that should help you develop and contribute to the +project. + +.. toctree:: + :maxdepth: 1 + + Developer Contribution Guide + Configure Zun with DevStack Manually + Setting Up Your Development Environment Under Mod WSGI + Running Tempest Tests + Running Unit Tests + +There are some other important documents also that helps new contributors to +contribute effectively towards code standards to the project. + +.. toctree:: + :maxdepth: 1 + + Adding a New API Method + Changing Zun DB Objects diff --git a/doc/source/dev/manual-devstack.rst b/doc/source/contributor/manual-devstack.rst similarity index 100% rename from doc/source/dev/manual-devstack.rst rename to doc/source/contributor/manual-devstack.rst diff --git a/doc/source/mod_wsgi.rst b/doc/source/contributor/mod-wsgi.rst similarity index 100% rename from doc/source/mod_wsgi.rst rename to doc/source/contributor/mod-wsgi.rst diff --git a/doc/source/objects.rst b/doc/source/contributor/objects.rst similarity index 100% rename from doc/source/objects.rst rename to doc/source/contributor/objects.rst diff --git a/doc/source/dev/quickstart.rst b/doc/source/contributor/quickstart.rst similarity index 100% rename from doc/source/dev/quickstart.rst rename to doc/source/contributor/quickstart.rst diff --git a/doc/source/dev/tempest_tests.rst b/doc/source/contributor/tempest-tests.rst similarity index 100% rename from doc/source/dev/tempest_tests.rst rename to doc/source/contributor/tempest-tests.rst diff --git a/doc/source/dev/unit_tests.rst b/doc/source/contributor/unit-tests.rst similarity index 100% rename from doc/source/dev/unit_tests.rst rename to doc/source/contributor/unit-tests.rst diff --git a/doc/source/usage.rst b/doc/source/contributor/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/contributor/usage.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 49429387d..b4bd7a043 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,26 +17,23 @@ Welcome to Zun's documentation! Zun is an OpenStack Container service. It aims to provide an OpenStack API for provisioning and managing containerized workload on OpenStack. -Contents -======== +Admin Guide +----------- .. toctree:: :maxdepth: 1 - dev/quickstart - dev/unit_tests - dev/tempest_tests - dev/manual-devstack - dev/api_microversion osprofiler - readme - installation - usage - contributing - mod_wsgi + +Contributor Guide +----------------- +.. toctree:: + :glob: + :maxdepth: 2 + + contributor/index Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`search` - diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index eb8659f36..000000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,12 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install zun - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv zun - $ pip install zun diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d8..000000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst