openstacksdk/doc/source/index.rst
Monty Taylor 40d425c595
Merge user and users sections of the docs
The openstack doc standard location is 'user', so go with that.
Incorporate pages from the shade and occ docs into the appropriate
places in the user index file.

This still leaves user/logging and user/guide/logging which need to be
rationalized. That will come in the next commit, as it also needs to
actually rationalize the logging helper functions.

Remove the Makefile, as it's not used by things.

Change-Id: I26f36370ef9651f4bcaa7dee3b903309463d9592
2018-01-15 19:19:50 -06:00

48 lines
821 B
ReStructuredText

Welcome to the OpenStack SDK!
=============================
This documentation is split into three sections:
* an :doc:`installation <install/index>` guide
* a section for :doc:`users <user/index>` looking to build applications
which make use of OpenStack
* a section for those looking to :doc:`contribute <contributor/index>`
to this project
Installation
------------
.. toctree::
:maxdepth: 2
install/index
For Users
---------
.. toctree::
:maxdepth: 2
user/index
For Contributors
----------------
.. toctree::
:maxdepth: 2
contributor/index
.. include:: ../../README.rst
General Information
-------------------
General information about the SDK including a glossary and release history.
.. toctree::
:maxdepth: 1
Glossary of Terms <glossary>
Release Notes <releasenotes>