79245a6283
Now that we are in charge of managing our documentation I thought we should have a section in the Contributor Guide on how to contribute documentation. This patch adds that. It also resolves build WARNINGS due to the README files I added not being included in any toctrees and adds the missing README file to the install directory. Change-Id: I8e12628b439a400ebd1ee6d691673a16e2c2f9d2
103 lines
2.1 KiB
ReStructuredText
103 lines
2.1 KiB
ReStructuredText
..
|
|
Copyright 2010-2011 United States Government as represented by the
|
|
Administrator of the National Aeronautics and Space Administration.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
Contributor Guide
|
|
=================
|
|
|
|
In this section you will find information on how to contribute to Cinder.
|
|
Content includes architectural overviews, tips and tricks for setting up a
|
|
development environment, and information on Cinder's lower level programming APIs,
|
|
|
|
|
|
Programming HowTos and Tutorials
|
|
--------------------------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
development.environment
|
|
api_microversion_dev
|
|
api_conditional_updates
|
|
api_microversion_history
|
|
testing
|
|
addmethod.openstackapi
|
|
drivers
|
|
gmr
|
|
replication
|
|
user_messages
|
|
migration
|
|
api.apache
|
|
rolling.upgrades
|
|
groups
|
|
|
|
Documentation Contribution
|
|
--------------------------
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
documentation
|
|
|
|
Background Concepts for Cinder
|
|
------------------------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
architecture
|
|
attach_detach_conventions
|
|
attach_detach_conventions_v2
|
|
threading
|
|
i18n
|
|
rpc
|
|
|
|
Other Resources
|
|
---------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
launchpad
|
|
gerrit
|
|
jenkins
|
|
releasenotes
|
|
|
|
API Reference
|
|
-------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
./api/autoindex
|
|
|
|
Module Reference
|
|
----------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
services
|
|
database
|
|
volume
|
|
auth
|
|
api
|
|
scheduler
|
|
fakes
|
|
cinder
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|