From 946490ea784028c2512fbcb8776f3c5354817942 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Mon, 10 Jul 2017 14:59:46 +0000 Subject: [PATCH] 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 --- .gitignore | 2 +- doc/source/conf.py | 2 +- doc/source/contributor/index.rst | 19 +++++++++++++++ doc/source/index.rst | 24 ++++++++----------- doc/source/{install.rst => install/index.rst} | 0 5 files changed, 31 insertions(+), 16 deletions(-) create mode 100644 doc/source/contributor/index.rst rename doc/source/{install.rst => install/index.rst} (100%) diff --git a/.gitignore b/.gitignore index 8501ec1..76c3e28 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ AUTHORS ChangeLog build cover -doc/source/sourcecode +doc/source/contributor/api/ node_modules npm-debug.log releasenotes/build diff --git a/doc/source/conf.py b/doc/source/conf.py index 61d3000..502973e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 = () diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..3937784 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,19 @@ +================= +Contributor Guide +================= + +There is no topic specific to Zun UI now. + +See `Horizon Developer Documents +`__ +for general topic on developing a dashboard on horizon. + + +Source Code Reference +--------------------- + +.. toctree:: + :glob: + :maxdepth: 1 + + api/autoindex diff --git a/doc/source/index.rst b/doc/source/index.rst index 553a1c7..b5811e1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 -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 diff --git a/doc/source/install.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/install.rst rename to doc/source/install/index.rst