rearrange existing documentation to fit the new standard layout

For more detail, see the doc migration spec:
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

The current installation document is mainly for contributors not operators.
It is better to be reviit later, but it is beyond the scope of this patch.

Change-Id: Ic4ae4cc7cf399446ba5e25a97698ddb2c075b510
This commit is contained in:
Akihiro Motoki 2017-07-10 14:44:41 +00:00
parent 616994b7e5
commit 4a3ba73cc0
5 changed files with 29 additions and 16 deletions

2
.gitignore vendored
View File

@ -2,7 +2,7 @@ AUTHORS
ChangeLog
build
cover
doc/source/sourcecode
doc/source/contributor/api/
magnum_ui/test/.secret_key_store
node_modules
npm-debug.log

View File

@ -71,7 +71,7 @@ def write_autodoc_index():
modlist.append(result)
return modlist
RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "sourcecode"))
RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "contributor/api"))
SRCS = [('magnum_ui', ROOT), ]
EXCLUDED_MODULES = ()

View File

@ -0,0 +1,17 @@
=================
Contributor Guide
=================
There is no topic specific to Magnum UI now.
See `Horizon Developer Documents
<https://docs.openstack.org/horizon/latest/contributor/index.html>`__
Source Code Reference
---------------------
.. toctree::
:glob:
:maxdepth: 1
api/autoindex

View File

@ -8,24 +8,20 @@ Horizon plugin for Magnum
* Source: http://git.openstack.org/cgit/openstack/magnum-ui
* Bugs: http://bugs.launchpad.net/magnum-ui
Usage
-----
User Documentation
------------------
.. toctree::
:maxdepth: 1
:maxdepth: 2
install
install/index
Release Notes <https://docs.openstack.org/releasenotes/magnum-ui/>
Release Notes
-------------
* https://docs.openstack.org/releasenotes/magnum-ui/
Source Code Reference
---------------------
Contributor Guide
-----------------
.. toctree::
:glob:
:maxdepth: 1
:maxdepth: 2
sourcecode/autoindex
contributor/index