From ac477b8f7b3adf9490c2c249b44003ca99cd0d6a Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 2 Oct 2017 13:18:53 +0200 Subject: [PATCH] Install Guides, not Tutorials Change all remaining occurences to speak only about Installation Guides. Change-Id: Ie590d35bd4b68152a64f0a7e2dda6aa0b250a1b1 --- README.rst | 2 +- doc/arch-design/source/index.rst | 2 +- doc/common/app-support.rst | 2 +- doc/doc-contrib-guide/source/blueprints-and-specs.rst | 10 +++++----- doc/doc-contrib-guide/source/project-install-guide.rst | 4 ++-- doc/doc-contrib-guide/source/quickstart/developers.rst | 2 +- .../source/quickstart/first-timers.rst | 2 +- .../source/quickstart/new-projects.rst | 2 +- doc/doc-contrib-guide/source/release/taskdetail.rst | 6 +++--- doc/doc-contrib-guide/source/release/taskoverview.rst | 2 +- doc/doc-contrib-guide/source/rst-conv/profiling.rst | 2 +- doc/ha-guide-draft/source/compute-node-ha.rst | 2 +- doc/ha-guide-draft/source/index.rst | 2 +- doc/ha-guide-draft/source/intro-os-ha-memcached.rst | 2 +- doc/ha-guide-draft/source/networking-ha.rst | 2 +- doc/ha-guide-draft/source/storage-ha-image.rst | 2 +- doc/ha-guide/source/compute-node-ha.rst | 2 +- doc/ha-guide/source/environment-hardware.rst | 4 ++-- doc/ha-guide/source/environment-memcached.rst | 2 +- doc/ha-guide/source/environment-ntp.rst | 2 +- doc/ha-guide/source/environment-operatingsystem.rst | 4 ++-- doc/ha-guide/source/index.rst | 2 +- doc/ha-guide/source/networking-ha.rst | 2 +- doc/ha-guide/source/storage-ha-image.rst | 2 +- doc/install-guide/source/openstack-services.rst | 2 +- www/ocata/install/obs-services.html | 2 +- www/ocata/install/rdo-services.html | 2 +- www/ocata/install/ubuntu-services.html | 2 +- www/pike/install/index.html | 6 +++--- www/queens/install/index.html | 6 +++--- 30 files changed, 43 insertions(+), 43 deletions(-) diff --git a/README.rst b/README.rst index 6831724af8..f62bd728bb 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,7 @@ It includes these manuals: * Configuration Reference * Documentation Contributor Guide * High Availability Guide - * Installation Tutorials + * Installation Guides * Networking Guide * Operations Guide * Virtual Machine Image Guide diff --git a/doc/arch-design/source/index.rst b/doc/arch-design/source/index.rst index 1f539ef46b..0835c33813 100644 --- a/doc/arch-design/source/index.rst +++ b/doc/arch-design/source/index.rst @@ -35,7 +35,7 @@ Before reading this book, we recommend: * A basic understanding of networking principles and protocols. For information about deploying and operating OpenStack, see the -`Installation Tutorials and Guides `_, +`Installation Guides `_, `Deployment Guides `_, and the `OpenStack Operations Guide `_. diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index 070e6ddbdf..cdfa60d632 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -32,7 +32,7 @@ bug `_. The following guides explain how to install an OpenStack cloud and its associated components: -* `OpenStack Pike Installation Tutorials and Guides `_ +* `OpenStack Pike Installation Guides `_ The following books explain how to configure and run an OpenStack cloud: diff --git a/doc/doc-contrib-guide/source/blueprints-and-specs.rst b/doc/doc-contrib-guide/source/blueprints-and-specs.rst index 9af2f95ea5..fb58cc8723 100644 --- a/doc/doc-contrib-guide/source/blueprints-and-specs.rst +++ b/doc/doc-contrib-guide/source/blueprints-and-specs.rst @@ -93,23 +93,23 @@ Installation Guides: - Source location - Target location - * - Installation Tutorial for openSUSE and SUSE Linux Enterprise Server + * - Installation Guide for openSUSE and SUSE Linux Enterprise Server - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide - https://docs.openstack.org/ocata/install-guide-obs/ - * - Installation Tutorial for Red Hat Enterprise Linux and CentOS + * - Installation Guide for Red Hat Enterprise Linux and CentOS - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide - https://docs.openstack.org/ocata/install-guide-rdo/ - * - Installation Tutorial for Ubuntu 16.04 (LTS) + * - Installation Guide for Ubuntu 16.04 (LTS) - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide - https://docs.openstack.org/ocata/install-guide-ubuntu/ - * - Installation Tutorial For Debian With Debconf (is not provided for Ocata) + * - Installation Guide For Debian With Debconf (is not provided for Ocata) - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide - https://docs.openstack.org/newton/install-guide-debconf/ - * - Installation Tutorial For Debian (is not provided for Ocata) + * - Installation Guide For Debian (is not provided for Ocata) - https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide - https://docs.openstack.org/newton/install-guide-debian/ diff --git a/doc/doc-contrib-guide/source/project-install-guide.rst b/doc/doc-contrib-guide/source/project-install-guide.rst index f723f751bf..02dcd0642b 100644 --- a/doc/doc-contrib-guide/source/project-install-guide.rst +++ b/doc/doc-contrib-guide/source/project-install-guide.rst @@ -20,8 +20,8 @@ is listed along with the guides from other projects. Newton and Ocata ~~~~~~~~~~~~~~~~ -For the Newton release, a new method of publishing installation tutorials -and guides is being implemented. This will allow each big tent project to +For the Newton release, a new method of publishing installation +guides is being implemented. This will allow each big tent project to create their own installation guide, based on a standard template, in their own repository. These guides are then centrally published to `docs.openstack.org `_. diff --git a/doc/doc-contrib-guide/source/quickstart/developers.rst b/doc/doc-contrib-guide/source/quickstart/developers.rst index 7bc4aae5dc..88a085f364 100644 --- a/doc/doc-contrib-guide/source/quickstart/developers.rst +++ b/doc/doc-contrib-guide/source/quickstart/developers.rst @@ -40,7 +40,7 @@ quickly and easily: ask you to create a blueprint and specification for the change. If you are unsure whether your change will require a blueprint or specification, ask on the mailing list for guidance. -* If you want to create a new Installation Tutorial for your big tent +* If you want to create a new Installation Guide for your big tent project, see :doc:`../project-install-guide`. * Remember, you can always contact the documentation team through our mailing list, or on IRC. diff --git a/doc/doc-contrib-guide/source/quickstart/first-timers.rst b/doc/doc-contrib-guide/source/quickstart/first-timers.rst index cae2df8b9a..baac4f61e1 100644 --- a/doc/doc-contrib-guide/source/quickstart/first-timers.rst +++ b/doc/doc-contrib-guide/source/quickstart/first-timers.rst @@ -5,7 +5,7 @@ First timers ============ One of the best ways to start contributing to OpenStack documentation -is to walk through the Installation Tutorial and complete it by hand. +is to walk through the Installation Guide and complete it by hand. Keep notes as you go, and offer suggestions for improvement by filing documentation bugs at Launchpad. diff --git a/doc/doc-contrib-guide/source/quickstart/new-projects.rst b/doc/doc-contrib-guide/source/quickstart/new-projects.rst index 6e7fc72c68..3da8c8c137 100644 --- a/doc/doc-contrib-guide/source/quickstart/new-projects.rst +++ b/doc/doc-contrib-guide/source/quickstart/new-projects.rst @@ -19,6 +19,6 @@ Any configuration options or command line tools should be documented using the automated ``openstack-doc-tools``. For more information about these automated tools, see the :ref:`doc-tools` chapter. -To create an Installation Tutorial in accordance with the OpenStack +To create an Installation Guide in accordance with the OpenStack Foundation Project Navigator, follow the instructions at :ref:`project-install-guide`. diff --git a/doc/doc-contrib-guide/source/release/taskdetail.rst b/doc/doc-contrib-guide/source/release/taskdetail.rst index 75b2693da9..9fd584f705 100644 --- a/doc/doc-contrib-guide/source/release/taskdetail.rst +++ b/doc/doc-contrib-guide/source/release/taskdetail.rst @@ -4,10 +4,10 @@ Release task detail This section provides detailed instructions for each release task. -Installation Tutorial testing +Installation Guide testing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The process for Installation Tutorial testing begins about six weeks before +The process for Installation Guide testing begins about six weeks before release day. First of all, create a new testing page on the wiki, based on `the previous one `_. @@ -40,7 +40,7 @@ possible that changes might have happened within projects during the release that have not been reflected in the documentation. As release day draws near, and testing progresses, the PTL will make a -judgment call on whether or not the various Installation Tutorials are +judgment call on whether or not the various Installation Guides are tested sufficiently to be released. In some rare cases, the book either has not been tested adequately, or has performed badly in tests, which can justify not publishing that book. In this case, the PTL will contact diff --git a/doc/doc-contrib-guide/source/release/taskoverview.rst b/doc/doc-contrib-guide/source/release/taskoverview.rst index 74d1342809..06d9c2f5a5 100644 --- a/doc/doc-contrib-guide/source/release/taskoverview.rst +++ b/doc/doc-contrib-guide/source/release/taskoverview.rst @@ -10,7 +10,7 @@ Release day is usually 1300UTC on the `initial release date` listed on the *Four to six weeks before release* Ping packagers to locate pre-release packages to test the Installation - Tutorial against, and start looking for willing volunteers to help test. + Guide against, and start looking for willing volunteers to help test. *Four weeks* Ping Cross Project Liaisons (CPLs) to check their chapters, and ping diff --git a/doc/doc-contrib-guide/source/rst-conv/profiling.rst b/doc/doc-contrib-guide/source/rst-conv/profiling.rst index 9659e71610..00ea6de218 100644 --- a/doc/doc-contrib-guide/source/rst-conv/profiling.rst +++ b/doc/doc-contrib-guide/source/rst-conv/profiling.rst @@ -2,7 +2,7 @@ Profiling (conditional content) =============================== -Installation Tutorials and Guides has content that depends upon the operating +Installation Guides has content that depends upon the operating systems. Use the ``only`` directive to specify the content that is operating-system diff --git a/doc/ha-guide-draft/source/compute-node-ha.rst b/doc/ha-guide-draft/source/compute-node-ha.rst index 92e1149eb7..b1cf30bcea 100644 --- a/doc/ha-guide-draft/source/compute-node-ha.rst +++ b/doc/ha-guide-draft/source/compute-node-ha.rst @@ -2,7 +2,7 @@ Configuring the compute node ============================ -The `Installation Tutorials and Guides +The `Installation Guides `_ provide instructions for installing multiple compute nodes. To make the compute nodes highly available, you must configure the diff --git a/doc/ha-guide-draft/source/index.rst b/doc/ha-guide-draft/source/index.rst index c1b39e359f..5cee68d644 100644 --- a/doc/ha-guide-draft/source/index.rst +++ b/doc/ha-guide-draft/source/index.rst @@ -6,7 +6,7 @@ Abstract ~~~~~~~~ This guide describes how to install and configure OpenStack for high -availability. It supplements the Installation Tutorials and Guides +availability. It supplements the Installation Guides and assumes that you are familiar with the material in those guides. This guide documents OpenStack Ocata, Newton, and Mitaka releases. diff --git a/doc/ha-guide-draft/source/intro-os-ha-memcached.rst b/doc/ha-guide-draft/source/intro-os-ha-memcached.rst index dc1de6e98c..a1b3d8a135 100644 --- a/doc/ha-guide-draft/source/intro-os-ha-memcached.rst +++ b/doc/ha-guide-draft/source/intro-os-ha-memcached.rst @@ -31,5 +31,5 @@ By default, ``controller1`` handles the caching service. If the host goes down, For more information about Memcached installation, see the *Environment -> Memcached* section in the -`Installation Tutorials and Guides `_ +`Installation Guides `_ depending on your distribution. diff --git a/doc/ha-guide-draft/source/networking-ha.rst b/doc/ha-guide-draft/source/networking-ha.rst index 47f4864bac..fa1ae1e038 100644 --- a/doc/ha-guide-draft/source/networking-ha.rst +++ b/doc/ha-guide-draft/source/networking-ha.rst @@ -4,7 +4,7 @@ Configuring the networking services Configure networking on each node. See the basic information about configuring networking in the Networking service section of the -`Install Tutorials and Guides `_, +`Install Guides `_, depending on your distribution. OpenStack network nodes contain: diff --git a/doc/ha-guide-draft/source/storage-ha-image.rst b/doc/ha-guide-draft/source/storage-ha-image.rst index cb775b1f3a..3b1de9c98a 100644 --- a/doc/ha-guide-draft/source/storage-ha-image.rst +++ b/doc/ha-guide-draft/source/storage-ha-image.rst @@ -16,7 +16,7 @@ Prerequisites Before beginning, ensure that you are familiar with the documentation for installing the OpenStack Image API service. See the *Image service* section in the -`Installation Tutorials and Guides `_, +`Installation Guides `_, depending on your distribution. .. _glance-api-pacemaker: diff --git a/doc/ha-guide/source/compute-node-ha.rst b/doc/ha-guide/source/compute-node-ha.rst index 04346c1b68..940ea507f9 100644 --- a/doc/ha-guide/source/compute-node-ha.rst +++ b/doc/ha-guide/source/compute-node-ha.rst @@ -2,7 +2,7 @@ Configuring the compute node ============================ -The `Installation Tutorials and Guides +The `Installation Guides `_ provide instructions for installing multiple compute nodes. To make the compute nodes highly available, you must configure the diff --git a/doc/ha-guide/source/environment-hardware.rst b/doc/ha-guide/source/environment-hardware.rst index 49bb06495a..23a993f22e 100644 --- a/doc/ha-guide/source/environment-hardware.rst +++ b/doc/ha-guide/source/environment-hardware.rst @@ -12,11 +12,11 @@ The following are the standard hardware requirements: - Provider networks: See the *Overview -> Networking Option 1: Provider networks* section of the - `Install Tutorials and Guides `_ + `Install Guides `_ depending on your distribution. - Self-service networks: See the *Overview -> Networking Option 2: Self-service networks* section of the - `Install Tutorials and Guides `_ + `Install Guides `_ depending on your distribution. OpenStack does not require a significant amount of resources and the following diff --git a/doc/ha-guide/source/environment-memcached.rst b/doc/ha-guide/source/environment-memcached.rst index a71534ce2d..cdf01a6ce1 100644 --- a/doc/ha-guide/source/environment-memcached.rst +++ b/doc/ha-guide/source/environment-memcached.rst @@ -28,5 +28,5 @@ By default, ``controller1`` handles the caching service. If the host goes down, For more information about Memcached installation, see the *Environment -> Memcached* section in the -`Installation Tutorials and Guides `_ +`Installation Guides `_ depending on your distribution. diff --git a/doc/ha-guide/source/environment-ntp.rst b/doc/ha-guide/source/environment-ntp.rst index ced0c2a605..705986941e 100644 --- a/doc/ha-guide/source/environment-ntp.rst +++ b/doc/ha-guide/source/environment-ntp.rst @@ -6,5 +6,5 @@ You must configure NTP to properly synchronize services among nodes. We recommend that you configure the controller node to reference more accurate (lower stratum) servers and other nodes to reference the controller node. For more information, see the -`Installation Tutorials and Guides +`Installation Guides `_. diff --git a/doc/ha-guide/source/environment-operatingsystem.rst b/doc/ha-guide/source/environment-operatingsystem.rst index a7f83a3bad..cada295540 100644 --- a/doc/ha-guide/source/environment-operatingsystem.rst +++ b/doc/ha-guide/source/environment-operatingsystem.rst @@ -5,10 +5,10 @@ Installing the operating system The first step in setting up your highly available OpenStack cluster is to install the operating system on each node. Follow the instructions in the *Environment* section of the -`Installation Tutorials and Guides `_ +`Installation Guides `_ depending on your distribution. -The OpenStack Installation Tutorials and Guides also include a list of +The OpenStack Installation Guides also include a list of the services that use passwords with important notes about using them. diff --git a/doc/ha-guide/source/index.rst b/doc/ha-guide/source/index.rst index 7e35422975..ff25288296 100644 --- a/doc/ha-guide/source/index.rst +++ b/doc/ha-guide/source/index.rst @@ -6,7 +6,7 @@ Abstract ~~~~~~~~ This guide describes how to install and configure OpenStack for high -availability. It supplements the Installation Tutorials and Guides +availability. It supplements the Installation Guides and assumes that you are familiar with the material in those guides. .. important:: diff --git a/doc/ha-guide/source/networking-ha.rst b/doc/ha-guide/source/networking-ha.rst index c50c3e2fa0..81615ca83e 100644 --- a/doc/ha-guide/source/networking-ha.rst +++ b/doc/ha-guide/source/networking-ha.rst @@ -11,7 +11,7 @@ Configuring the networking services Configure networking on each node. See the basic information about configuring networking in the *Networking service* section of the -`Install Tutorials and Guides `_, +`Install Guides `_, depending on your distribution. OpenStack network nodes contain: diff --git a/doc/ha-guide/source/storage-ha-image.rst b/doc/ha-guide/source/storage-ha-image.rst index 0a5734c87d..9081a5ebeb 100644 --- a/doc/ha-guide/source/storage-ha-image.rst +++ b/doc/ha-guide/source/storage-ha-image.rst @@ -16,7 +16,7 @@ Prerequisites Before beginning, ensure that you are familiar with the documentation for installing the OpenStack Image API service. See the *Image service* section in the -`Installation Tutorials and Guides `_, +`Installation Guides `_, depending on your distribution. .. _glance-api-pacemaker: diff --git a/doc/install-guide/source/openstack-services.rst b/doc/install-guide/source/openstack-services.rst index 03c9147cb9..a1fff8142b 100644 --- a/doc/install-guide/source/openstack-services.rst +++ b/doc/install-guide/source/openstack-services.rst @@ -6,7 +6,7 @@ The installation of individual OpenStack services is covered in the Project Installation Guides that are available at the following locations: -* `OpenStack Installation Tutorials and Guides for Pike +* `OpenStack Installation Guides for Pike `_ .. Note that this guide is release independent, so we will add more diff --git a/www/ocata/install/obs-services.html b/www/ocata/install/obs-services.html index 0fbeacf06d..954e98cd03 100644 --- a/www/ocata/install/obs-services.html +++ b/www/ocata/install/obs-services.html @@ -24,7 +24,7 @@
-

Installation Tutorials

+

Installation Guides

openSUSE and SUSE Linux Enterprise diff --git a/www/ocata/install/rdo-services.html b/www/ocata/install/rdo-services.html index 0af1bed823..b48a61b1be 100644 --- a/www/ocata/install/rdo-services.html +++ b/www/ocata/install/rdo-services.html @@ -25,7 +25,7 @@

-

Installation Tutorials

+

Installation Guide

Red Hat Enterprise Linux and CentOS diff --git a/www/ocata/install/ubuntu-services.html b/www/ocata/install/ubuntu-services.html index 933479d6a5..6d8f3f7280 100644 --- a/www/ocata/install/ubuntu-services.html +++ b/www/ocata/install/ubuntu-services.html @@ -24,7 +24,7 @@

-

Installation Tutorials

+

Installation Guide

Ubuntu diff --git a/www/pike/install/index.html b/www/pike/install/index.html index 643f87d744..03aa346a7b 100644 --- a/www/pike/install/index.html +++ b/www/pike/install/index.html @@ -28,14 +28,14 @@

-

Installation Tutorial

-

The following tutorial provides information about getting started, +

Installation Guide

+

The following guide provides information about getting started, setting up your environment, and launching your instance.

- OpenStack Installation Tutorial + OpenStack Installation Guide

diff --git a/www/queens/install/index.html b/www/queens/install/index.html index 643f87d744..03aa346a7b 100644 --- a/www/queens/install/index.html +++ b/www/queens/install/index.html @@ -28,14 +28,14 @@
-

Installation Tutorial

-

The following tutorial provides information about getting started, +

Installation Guide

+

The following guide provides information about getting started, setting up your environment, and launching your instance.

- OpenStack Installation Tutorial + OpenStack Installation Guide