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: Ibdbb20131b5c7bea6a1e6ab8ff47b971889ad319
This commit is contained in:
Akihiro Motoki 2017-07-10 14:59:46 +00:00
parent ef783af9df
commit 946490ea78
5 changed files with 31 additions and 16 deletions

2
.gitignore vendored
View File

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

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 = [('zun_ui', ROOT), ]
EXCLUDED_MODULES = ()

View File

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

View File

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