Merge "Move the contributor related docs to contributor/ dir"
This commit is contained in:
commit
64e62b52f2
|
@ -1,4 +1,4 @@
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -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>
|
|
@ -53,25 +53,32 @@ Features
|
||||||
* Integration with Neutron for Kubernetes multi-tenancy network security
|
* Integration with Neutron for Kubernetes multi-tenancy network security
|
||||||
* Integration with Cinder to provide volume service for containers
|
* Integration with Cinder to provide volume service for containers
|
||||||
|
|
||||||
Developer Info
|
User Documentation
|
||||||
==============
|
==================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
dev/quickstart
|
|
||||||
policies.rst
|
policies.rst
|
||||||
dev/cluster-type-definition.rst
|
dev/cluster-type-definition.rst
|
||||||
dev/kubernetes-load-balancer.rst
|
dev/kubernetes-load-balancer.rst
|
||||||
dev/functional-test.rst
|
|
||||||
dev/reno.rst
|
|
||||||
dev/api_microversion.rst
|
|
||||||
api_microversion_history.rst
|
api_microversion_history.rst
|
||||||
magnum-proxy.rst
|
|
||||||
contributing
|
|
||||||
heat-templates
|
heat-templates
|
||||||
objects
|
|
||||||
|
|
||||||
|
Contributor Guide
|
||||||
|
=================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
contributor/index
|
||||||
|
|
||||||
|
Admin Guide
|
||||||
|
===========
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
gmr.rst
|
gmr.rst
|
||||||
|
magnum-proxy.rst
|
||||||
|
|
||||||
Work In Progress
|
Work In Progress
|
||||||
================
|
================
|
||||||
|
|
Loading…
Reference in New Issue