reorganize docs using the new standard layout
Move the docs around a little to allow the new templated docs.o.o site link to things like the user and install guides in the expected location. Change-Id: I7f3b625c04aa6cd2a7ebe5f2ce4a398cf464b1cc Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
32feee698d
commit
20b2f1f0c0
@ -1 +0,0 @@
|
||||
.. include:: ../../CONTRIBUTING.rst
|
@ -73,7 +73,7 @@ All objects should be normalized. It is shade's purpose in life to make
|
||||
OpenStack consistent for end users, and this means not trusting the clouds
|
||||
to return consistent objects. There should be a normalize function in
|
||||
`shade/_normalize.py` that is applied to objects before returning them to
|
||||
the user. See :doc:`model` for further details on object model requirements.
|
||||
the user. See :doc:`../user/model` for further details on object model requirements.
|
||||
|
||||
Fields should not be in the normalization contract if we cannot commit to
|
||||
providing them to all users.
|
1
doc/source/contributor/contributing.rst
Normal file
1
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1 @@
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
9
doc/source/contributor/index.rst
Normal file
9
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=========================
|
||||
Shade Contributor Guide
|
||||
=========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
coding
|
@ -11,25 +11,13 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
usage
|
||||
logging
|
||||
model
|
||||
contributing
|
||||
coding
|
||||
microversions
|
||||
releasenotes
|
||||
install/index
|
||||
user/index
|
||||
contributor/index
|
||||
releasenotes/index
|
||||
|
||||
.. include:: ../../README.rst
|
||||
|
||||
Presentations
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
multi-cloud-demo
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
19
doc/source/user/index.rst
Normal file
19
doc/source/user/index.rst
Normal file
@ -0,0 +1,19 @@
|
||||
==================
|
||||
Shade User Guide
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
usage
|
||||
logging
|
||||
model
|
||||
microversions
|
||||
|
||||
Presentations
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
multi-cloud-demo
|
@ -7,7 +7,7 @@ walk through it like a presentation, install `presentty` and run:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
presentty doc/source/multi-cloud-demo.rst
|
||||
presentty doc/source/user/multi-cloud-demo.rst
|
||||
|
||||
The content is hopefully helpful even if it's not being narrated, so it's being
|
||||
included in the `shade` docs.
|
Loading…
x
Reference in New Issue
Block a user