From c32d5a38093fee0f1058f0b915c6dbb99a5b6692 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Mon, 18 Mar 2019 11:04:17 +0000 Subject: [PATCH] Rename and restructure install docs The concept/name of controller was copied over from nova when the docs were imported. That concept doesn't really fit in with placement and also does not describe what the docs are actually doing. We're not installing a controller, we're installing placement. Thus filenames and titles are updated and intro paragraphs clarified. Also, the endpoints.rst file is moved into a shared directory as it is not a standalone install doc. Note that the big warning remains on the top of the install docs because it is still true. These instructions and the packages they mention have not been verified. Story: 2005190 Change-Id: I5fcbc90eda3ef74dba2336ea3e5c9f53938c6378 --- doc/source/index.rst | 6 +++--- doc/source/install/index.rst | 7 ++++--- .../{controller-install-obs.rst => install-obs.rst} | 10 +++++----- .../{controller-install-rdo.rst => install-rdo.rst} | 10 +++++----- ...ontroller-install-ubuntu.rst => install-ubuntu.rst} | 10 +++++----- doc/source/install/{ => shared}/endpoints.rst | 0 6 files changed, 22 insertions(+), 21 deletions(-) rename doc/source/install/{controller-install-obs.rst => install-obs.rst} (95%) rename doc/source/install/{controller-install-rdo.rst => install-rdo.rst} (94%) rename doc/source/install/{controller-install-ubuntu.rst => install-ubuntu.rst} (94%) rename doc/source/install/{ => shared}/endpoints.rst (100%) diff --git a/doc/source/index.rst b/doc/source/index.rst index fac982f17..19ccc1f6d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -278,9 +278,9 @@ This history of placement microversions may be found in contributor/index install/index install/from-pypi - install/controller-install-obs - install/controller-install-rdo - install/controller-install-ubuntu + install/install-obs + install/install-rdo + install/install-ubuntu install/verify placement-api-microversion-history usage/index diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index a88c22bd5..40d806324 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -22,8 +22,9 @@ placement with the rest of an OpenStack cloud. .. toctree:: :maxdepth: 1 - controller-install-obs.rst - controller-install-rdo.rst - controller-install-ubuntu.rst + from-pypi.rst + install-obs.rst + install-rdo.rst + install-ubuntu.rst .. _HTTP API: https://developer.openstack.org/api-ref/placement/ diff --git a/doc/source/install/controller-install-obs.rst b/doc/source/install/install-obs.rst similarity index 95% rename from doc/source/install/controller-install-obs.rst rename to doc/source/install/install-obs.rst index 9c8270649..56ec2a210 100644 --- a/doc/source/install/controller-install-obs.rst +++ b/doc/source/install/install-obs.rst @@ -1,8 +1,8 @@ -Install and configure controller node for openSUSE and SUSE Linux Enterprise -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Install and configure Placement for openSUSE and SUSE Linux Enterprise +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the placement service on -the controller node. +This section describes how to install and configure the placement service +when using openSUSE or SUSE Linux Enterprise packages. Prerequisites ------------- @@ -44,7 +44,7 @@ Create Database Configure User and Endpoints ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: endpoints.rst +.. include:: shared/endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/controller-install-rdo.rst b/doc/source/install/install-rdo.rst similarity index 94% rename from doc/source/install/controller-install-rdo.rst rename to doc/source/install/install-rdo.rst index d5806b7e4..d71d8e65d 100644 --- a/doc/source/install/controller-install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -1,8 +1,8 @@ -Install and configure controller node for Red Hat Enterprise Linux and CentOS -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Install and configure Placement for Red Hat Enterprise Linux and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the placement service on -the controller node. +This section describes how to install and configure the placement service +when using Red Hat Enterprise Linux or CentOS packages. Prerequisites ------------- @@ -44,7 +44,7 @@ Create Database Configure User and Endpoints ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: endpoints.rst +.. include:: shared/endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/controller-install-ubuntu.rst b/doc/source/install/install-ubuntu.rst similarity index 94% rename from doc/source/install/controller-install-ubuntu.rst rename to doc/source/install/install-ubuntu.rst index 6f46bff5b..15cf258e6 100644 --- a/doc/source/install/controller-install-ubuntu.rst +++ b/doc/source/install/install-ubuntu.rst @@ -1,8 +1,8 @@ -Install and configure controller node for Ubuntu -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Install and configure Placement for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the placement service on -the controller node. +This section describes how to install and configure the placement service +when using Ubuntu packages. Prerequisites ------------- @@ -44,7 +44,7 @@ Create Database Configure User and Endpoints ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: endpoints.rst +.. include:: shared/endpoints.rst Install and configure components -------------------------------- diff --git a/doc/source/install/endpoints.rst b/doc/source/install/shared/endpoints.rst similarity index 100% rename from doc/source/install/endpoints.rst rename to doc/source/install/shared/endpoints.rst