rearrange existing documentation to fit the new standard layout

Change-Id: Iac95a337ac0a3ae8da1dd7c0a575c4d7b68fe632
This commit is contained in:
Akihiro Motoki 2017-07-01 18:49:30 +09:00
parent b77c77f03e
commit 9d3fbc726f
10 changed files with 32 additions and 32 deletions

View File

@ -1,16 +1,13 @@
If you would like to contribute to the development of OpenStack, If you would like to contribute to the development of OpenStack,
you must follow the steps in this page: you must follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
http://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following should be submitted for review via the Gerrit tool, following
the workflow documented at: the workflow documented at:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored. Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/debtcollector
https://bugs.launchpad.net/debtcollector

View File

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

View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

View File

@ -1,3 +1,4 @@
=========================================
Welcome to debtcollector's documentation! Welcome to debtcollector's documentation!
========================================= =========================================
@ -11,27 +12,15 @@ collect your technical debt in a non-destructive manner.
integration is it aims to be generally usable and useful in any integration is it aims to be generally usable and useful in any
project. project.
Contents
========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation install/index
api user/index
examples reference/index
contributing contributor/index
Release Notes .. rubric:: Indices and tables
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`

View File

@ -1,6 +1,6 @@
=== =============
API API Reference
=== =============
The currently documented publicly exposed API's for usage in your project The currently documented publicly exposed API's for usage in your project

View File

@ -0,0 +1 @@
.. include:: ../../../ChangeLog

14
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,14 @@
===================
Using debtcollector
===================
.. toctree::
:maxdepth: 2
usage
.. history contains a lot of sections, toctree with maxdepth 1 is used.
.. toctree::
:maxdepth: 1
history

View File

@ -2,7 +2,7 @@
debtcollector Release Notes debtcollector Release Notes
============================= =============================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
unreleased unreleased