Move the contributor related docs to contributor/ dir
Change-Id: I79d168e60758722af4c9c4a0df69efb1728e3bd6 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Partial-Bug: #1703442
This commit is contained in:
parent
4c2f1ea5b6
commit
6e48d31a72
@ -1 +0,0 @@
|
||||
.. include:: ../../zun/api/rest_api_version_history.rst
|
0
doc/source/conf.py
Executable file → Normal file
0
doc/source/conf.py
Executable file → Normal file
@ -1,4 +1,4 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
31
doc/source/contributor/index.rst
Normal file
31
doc/source/contributor/index.rst
Normal file
@ -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 <quickstart>
|
||||
|
||||
There are documents that should help you develop and contribute to the
|
||||
project.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Developer Contribution Guide <contributing>
|
||||
Configure Zun with DevStack Manually <manual-devstack>
|
||||
Setting Up Your Development Environment Under Mod WSGI <mod-wsgi>
|
||||
Running Tempest Tests <tempest-tests>
|
||||
Running Unit Tests <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 <api-microversion>
|
||||
Changing Zun DB Objects <objects>
|
@ -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`
|
||||
|
||||
|
@ -1,12 +0,0 @@
|
||||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
At the command line::
|
||||
|
||||
$ pip install zun
|
||||
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
$ mkvirtualenv zun
|
||||
$ pip install zun
|
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
Loading…
Reference in New Issue
Block a user