From fb0dedb21125c9d854e65b1dd8df32612508bd75 Mon Sep 17 00:00:00 2001 From: Madhuri Kumari Date: Wed, 19 Jul 2017 15:22:52 +0530 Subject: [PATCH] [doc-migration] Add admin folder for related documents Change-Id: I4e53423f53fd70382a18fd7aca50145b5bd16fac --- doc/source/{ => admin}/configuring.rst | 0 doc/source/{ => admin}/gmr.rst | 0 doc/source/admin/index.rst | 27 +++++++++++++++++++ doc/source/{ => admin}/magnum-proxy.rst | 0 .../{ => admin}/troubleshooting-guide.rst | 3 --- doc/source/api_microversion_history.rst | 1 - .../contributor/api-microversion-history.rst | 1 + doc/source/contributor/index.rst | 2 ++ doc/source/{ => contributor}/policies.rst | 0 doc/source/index.rst | 9 +++---- 10 files changed, 33 insertions(+), 10 deletions(-) rename doc/source/{ => admin}/configuring.rst (100%) rename doc/source/{ => admin}/gmr.rst (100%) create mode 100644 doc/source/admin/index.rst rename doc/source/{ => admin}/magnum-proxy.rst (100%) rename doc/source/{ => admin}/troubleshooting-guide.rst (99%) delete mode 100644 doc/source/api_microversion_history.rst create mode 100644 doc/source/contributor/api-microversion-history.rst rename doc/source/{ => contributor}/policies.rst (100%) diff --git a/doc/source/configuring.rst b/doc/source/admin/configuring.rst similarity index 100% rename from doc/source/configuring.rst rename to doc/source/admin/configuring.rst diff --git a/doc/source/gmr.rst b/doc/source/admin/gmr.rst similarity index 100% rename from doc/source/gmr.rst rename to doc/source/admin/gmr.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 0000000000..b0b99c5c86 --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,27 @@ +Adminstrator's Guide +==================== + +Installation & Operations +------------------------- + +If you are a system administrator running Magnum, this section contains +information that should help you understand how to deploy, operate, and upgrade +the services. + +.. toctree:: + :maxdepth: 1 + + Magnum Proxy + gmr + Troubleshooting FAQ + +Configuration +------------- + +Following pages will be helpful in configuring specific aspects +of Magnum that may or may not be suitable to every situation. + +.. toctree:: + :maxdepth: 1 + + configuring diff --git a/doc/source/magnum-proxy.rst b/doc/source/admin/magnum-proxy.rst similarity index 100% rename from doc/source/magnum-proxy.rst rename to doc/source/admin/magnum-proxy.rst diff --git a/doc/source/troubleshooting-guide.rst b/doc/source/admin/troubleshooting-guide.rst similarity index 99% rename from doc/source/troubleshooting-guide.rst rename to doc/source/admin/troubleshooting-guide.rst index 342c805440..e433655e94 100644 --- a/doc/source/troubleshooting-guide.rst +++ b/doc/source/admin/troubleshooting-guide.rst @@ -12,7 +12,6 @@ with pointers to the details for troubleshooting. A separate section `for developers`_ describes useful techniques such as debugging unit tests and gate tests. -================ Failure symptoms ================ @@ -70,7 +69,6 @@ My cluster-create fails with a resource error on docker_volume Run "nova volume-list" to check the volume status. -======================= Troubleshooting details ======================= @@ -681,7 +679,6 @@ Heat software resource scripts *To be filled in* -============== For Developers ============== diff --git a/doc/source/api_microversion_history.rst b/doc/source/api_microversion_history.rst deleted file mode 100644 index 177f9a1e42..0000000000 --- a/doc/source/api_microversion_history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../magnum/api/rest_api_version_history.rst diff --git a/doc/source/contributor/api-microversion-history.rst b/doc/source/contributor/api-microversion-history.rst new file mode 100644 index 0000000000..7b64ce41eb --- /dev/null +++ b/doc/source/contributor/api-microversion-history.rst @@ -0,0 +1 @@ +.. include:: ../../../magnum/api/rest_api_version_history.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 6597ab0836..2c577c1c9a 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -24,3 +24,5 @@ contribute effectively towards code standards to the project. Writing a Release Note Adding a New API Method Changing Magnum DB Objects + api-microversion-history + policies diff --git a/doc/source/policies.rst b/doc/source/contributor/policies.rst similarity index 100% rename from doc/source/policies.rst rename to doc/source/contributor/policies.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 1a8ab502f8..30a1cd4678 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -58,10 +58,8 @@ User Documentation .. toctree:: :maxdepth: 1 - policies.rst dev/cluster-type-definition.rst dev/kubernetes-load-balancer.rst - api_microversion_history.rst heat-templates @@ -77,8 +75,7 @@ Admin Guide .. toctree:: :maxdepth: 1 - gmr.rst - magnum-proxy.rst + admin/index Work In Progress ================ @@ -86,7 +83,7 @@ Work In Progress .. toctree:: :maxdepth: 1 - troubleshooting-guide.rst + admin/troubleshooting-guide.rst userguide.rst - configuring.rst + admin/configuring.rst install-guide-from-source.rst