Move the contributor related docs to contributor/ dir

Please refer http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
for more details.

Change-Id: I7c8c76cf98c7538bf28c8fdb520121be4c1ca4c3
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
This commit is contained in:
Madhuri Kumari 2017-07-11 16:41:40 +05:30
parent 465d3c0e3c
commit b172f1cfd4
8 changed files with 44 additions and 11 deletions

View File

@ -1,4 +1,4 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst
.. include:: ../../../CONTRIBUTING.rst

View File

@ -0,0 +1,26 @@
Contributor's Guide
===================
Getting Started
---------------
If you are new to Magnum, this section contains information that should help
you get started as a developer working on the project or contributing to the
project.
.. toctree::
:maxdepth: 1
Developer Contribution Guide <contributing>
Setting Up Your Development Environment <quickstart>
Running Tempest Tests <functional-test>
There are some other important documents also that helps new contributors to
contribute effectively towards code standards to the project.
.. toctree::
:maxdepth: 1
Writing a Release Note <reno>
Adding a New API Method <api-microversion>
Changing Magnum DB Objects <objects>

View File

@ -53,25 +53,32 @@ Features
* Integration with Neutron for Kubernetes multi-tenancy network security
* Integration with Cinder to provide volume service for containers
Developer Info
==============
User Documentation
==================
.. toctree::
:maxdepth: 1
dev/quickstart
policies.rst
dev/cluster-type-definition.rst
dev/kubernetes-load-balancer.rst
dev/functional-test.rst
dev/reno.rst
dev/api_microversion.rst
api_microversion_history.rst
magnum-proxy.rst
contributing
heat-templates
objects
Contributor Guide
=================
.. toctree::
:maxdepth: 1
contributor/index
Admin Guide
===========
.. toctree::
:maxdepth: 1
gmr.rst
magnum-proxy.rst
Work In Progress
================