From a869abf951cef63548f92115cd46e7b80ef12c85 Mon Sep 17 00:00:00 2001 From: Hongbin Lu Date: Sat, 24 Mar 2018 17:44:50 +0000 Subject: [PATCH] Consolidate admin guide and configuration guide Both admin guide and configuration guide are targeting for the same group of readers. There is no need to separate these two guides. Move all contents under doc/source/admin to doc/source/configuration Change-Id: I7560a8a52c2c4a23758dda75ae2979a68dd7c060 --- doc/source/admin/README.rst | 7 ------- doc/source/admin/index.rst | 15 --------------- .../{admin => configuration}/clear-containers.rst | 0 doc/source/configuration/index.rst | 2 ++ .../{admin => configuration}/osprofiler.rst | 0 doc/source/contributor/documentation.rst | 1 - doc/source/index.rst | 7 ------- 7 files changed, 2 insertions(+), 30 deletions(-) delete mode 100644 doc/source/admin/README.rst delete mode 100644 doc/source/admin/index.rst rename doc/source/{admin => configuration}/clear-containers.rst (100%) rename doc/source/{admin => configuration}/osprofiler.rst (100%) diff --git a/doc/source/admin/README.rst b/doc/source/admin/README.rst deleted file mode 100644 index 8ba6efb58..000000000 --- a/doc/source/admin/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -=============================================== -Zun Administration Documentation (source/admin) -=============================================== - - -This directory is intended to hold any documentation that is related -to how to run or operate Zun. diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst deleted file mode 100644 index 72dbfff4d..000000000 --- a/doc/source/admin/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Administrator's Guide -===================== - -Installation & Operations -------------------------- - -If you are a system administrator running Zun, this section contains -information that should help you understand how to deploy, operate, and upgrade -the services. - -.. toctree:: - :maxdepth: 1 - - osprofiler - clear-containers diff --git a/doc/source/admin/clear-containers.rst b/doc/source/configuration/clear-containers.rst similarity index 100% rename from doc/source/admin/clear-containers.rst rename to doc/source/configuration/clear-containers.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index f6f549799..49a1ce889 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -6,3 +6,5 @@ Sample Configuration File sample-config policy + osprofiler + clear-containers diff --git a/doc/source/admin/osprofiler.rst b/doc/source/configuration/osprofiler.rst similarity index 100% rename from doc/source/admin/osprofiler.rst rename to doc/source/configuration/osprofiler.rst diff --git a/doc/source/contributor/documentation.rst b/doc/source/contributor/documentation.rst index 87930ff6f..afadeffbd 100644 --- a/doc/source/contributor/documentation.rst +++ b/doc/source/contributor/documentation.rst @@ -92,7 +92,6 @@ as is documented in the ``README`` in each directory: .. toctree:: :maxdepth: 1 - ../admin/README ../cli/README ../configuration/README ../contributor/README diff --git a/doc/source/index.rst b/doc/source/index.rst index 3a7de3abd..148591b53 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,13 +17,6 @@ Welcome to Zun's documentation! Zun is an OpenStack Container service. It aims to provide an OpenStack API for provisioning and managing containerized workload on OpenStack. -Admin Guide -~~~~~~~~~~~ -.. toctree:: - :maxdepth: 1 - - admin/index - Contributor Guide ~~~~~~~~~~~~~~~~~ .. toctree::