diff --git a/doc/source/admin/README.rst b/doc/source/admin/README.rst new file mode 100644 index 000000000..8ba6efb58 --- /dev/null +++ b/doc/source/admin/README.rst @@ -0,0 +1,7 @@ +=============================================== +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/configuration/clear-containers.rst b/doc/source/admin/clear-containers.rst similarity index 100% rename from doc/source/configuration/clear-containers.rst rename to doc/source/admin/clear-containers.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 000000000..72dbfff4d --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,15 @@ +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/configuration/osprofiler.rst b/doc/source/admin/osprofiler.rst similarity index 100% rename from doc/source/configuration/osprofiler.rst rename to doc/source/admin/osprofiler.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 49a1ce889..f6f549799 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -6,5 +6,3 @@ Sample Configuration File sample-config policy - osprofiler - clear-containers diff --git a/doc/source/contributor/documentation.rst b/doc/source/contributor/documentation.rst index afadeffbd..87930ff6f 100644 --- a/doc/source/contributor/documentation.rst +++ b/doc/source/contributor/documentation.rst @@ -92,6 +92,7 @@ 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 c34090ab5..7fb954567 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -104,6 +104,7 @@ Reference Material :maxdepth: 2 cli/index + admin/index configuration/index user/filter-scheduler reference/api-microversion-history