Install Guides, not Tutorials

Change all remaining occurences to speak only about Installation Guides.

Change-Id: Ie590d35bd4b68152a64f0a7e2dda6aa0b250a1b1
This commit is contained in:
Andreas Jaeger
2017-10-02 13:18:53 +02:00
parent 76f7c6cb86
commit ac477b8f7b
30 changed files with 43 additions and 43 deletions

View File

@@ -23,7 +23,7 @@ It includes these manuals:
* Configuration Reference * Configuration Reference
* Documentation Contributor Guide * Documentation Contributor Guide
* High Availability Guide * High Availability Guide
* Installation Tutorials * Installation Guides
* Networking Guide * Networking Guide
* Operations Guide * Operations Guide
* Virtual Machine Image Guide * Virtual Machine Image Guide

View File

@@ -35,7 +35,7 @@ Before reading this book, we recommend:
* A basic understanding of networking principles and protocols. * A basic understanding of networking principles and protocols.
For information about deploying and operating OpenStack, see the For information about deploying and operating OpenStack, see the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_, `Installation Guides <https://docs.openstack.org/ocata/install/>`_,
`Deployment Guides <https://docs.openstack.org/ocata/deploy/>`_, `Deployment Guides <https://docs.openstack.org/ocata/deploy/>`_,
and the `OpenStack Operations Guide <https://docs.openstack.org/ops-guide/>`_. and the `OpenStack Operations Guide <https://docs.openstack.org/ops-guide/>`_.

View File

@@ -32,7 +32,7 @@ bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`_.
The following guides explain how to install an OpenStack cloud and its The following guides explain how to install an OpenStack cloud and its
associated components: associated components:
* `OpenStack Pike Installation Tutorials and Guides <https://docs.openstack.org/pike/install/>`_ * `OpenStack Pike Installation Guides <https://docs.openstack.org/pike/install/>`_
The following books explain how to configure and run an OpenStack cloud: The following books explain how to configure and run an OpenStack cloud:

View File

@@ -93,23 +93,23 @@ Installation Guides:
- Source location - Source location
- Target 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://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
- https://docs.openstack.org/ocata/install-guide-obs/ - 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://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
- https://docs.openstack.org/ocata/install-guide-rdo/ - 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://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
- https://docs.openstack.org/ocata/install-guide-ubuntu/ - 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://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
- https://docs.openstack.org/newton/install-guide-debconf/ - 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://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide
- https://docs.openstack.org/newton/install-guide-debian/ - https://docs.openstack.org/newton/install-guide-debian/

View File

@@ -20,8 +20,8 @@ is listed along with the guides from other projects.
Newton and Ocata Newton and Ocata
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
For the Newton release, a new method of publishing installation tutorials For the Newton release, a new method of publishing installation
and guides is being implemented. This will allow each big tent project to guides is being implemented. This will allow each big tent project to
create their own installation guide, based on a standard template, create their own installation guide, based on a standard template,
in their own repository. These guides are then centrally published to in their own repository. These guides are then centrally published to
`docs.openstack.org <https://docs.openstack.org>`_. `docs.openstack.org <https://docs.openstack.org>`_.

View File

@@ -40,7 +40,7 @@ quickly and easily:
ask you to create a blueprint and specification for the change. If you are 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 unsure whether your change will require a blueprint or specification, ask
on the mailing list for guidance. 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`. project, see :doc:`../project-install-guide`.
* Remember, you can always contact the documentation team through our mailing * Remember, you can always contact the documentation team through our mailing
list, or on IRC. list, or on IRC.

View File

@@ -5,7 +5,7 @@ First timers
============ ============
One of the best ways to start contributing to OpenStack documentation 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 Keep notes as you go, and offer suggestions for improvement by filing
documentation bugs at Launchpad. documentation bugs at Launchpad.

View File

@@ -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 the automated ``openstack-doc-tools``. For more information about these
automated tools, see the :ref:`doc-tools` chapter. 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 Foundation Project Navigator, follow the instructions at
:ref:`project-install-guide`. :ref:`project-install-guide`.

View File

@@ -4,10 +4,10 @@ Release task detail
This section provides detailed instructions for each release task. 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 release day. First of all, create a new testing page on the wiki, based on
`the previous one `the previous one
<https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting>`_. <https://wiki.openstack.org/wiki/Documentation/NewtonDocTesting>`_.
@@ -40,7 +40,7 @@ possible that changes might have happened within projects during the
release that have not been reflected in the documentation. release that have not been reflected in the documentation.
As release day draws near, and testing progresses, the PTL will make a 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 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 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 justify not publishing that book. In this case, the PTL will contact

View File

@@ -10,7 +10,7 @@ Release day is usually 1300UTC on the `initial release date` listed on the
*Four to six weeks before release* *Four to six weeks before release*
Ping packagers to locate pre-release packages to test the Installation 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* *Four weeks*
Ping Cross Project Liaisons (CPLs) to check their chapters, and ping Ping Cross Project Liaisons (CPLs) to check their chapters, and ping

View File

@@ -2,7 +2,7 @@
Profiling (conditional content) Profiling (conditional content)
=============================== ===============================
Installation Tutorials and Guides has content that depends upon the operating Installation Guides has content that depends upon the operating
systems. systems.
Use the ``only`` directive to specify the content that is operating-system Use the ``only`` directive to specify the content that is operating-system

View File

@@ -2,7 +2,7 @@
Configuring the compute node Configuring the compute node
============================ ============================
The `Installation Tutorials and Guides The `Installation Guides
<https://docs.openstack.org/ocata/install/>`_ <https://docs.openstack.org/ocata/install/>`_
provide instructions for installing multiple compute nodes. provide instructions for installing multiple compute nodes.
To make the compute nodes highly available, you must configure the To make the compute nodes highly available, you must configure the

View File

@@ -6,7 +6,7 @@ Abstract
~~~~~~~~ ~~~~~~~~
This guide describes how to install and configure OpenStack for high 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. and assumes that you are familiar with the material in those guides.
This guide documents OpenStack Ocata, Newton, and Mitaka releases. This guide documents OpenStack Ocata, Newton, and Mitaka releases.

View File

@@ -31,5 +31,5 @@ By default, ``controller1`` handles the caching service. If the host goes down,
For more information about Memcached installation, see the For more information about Memcached installation, see the
*Environment -> Memcached* section in the *Environment -> Memcached* section in the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_ `Installation Guides <https://docs.openstack.org/ocata/install/>`_
depending on your distribution. depending on your distribution.

View File

@@ -4,7 +4,7 @@ Configuring the networking services
Configure networking on each node. See the basic information about Configure networking on each node. See the basic information about
configuring networking in the Networking service section of the configuring networking in the Networking service section of the
`Install Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_, `Install Guides <https://docs.openstack.org/ocata/install/>`_,
depending on your distribution. depending on your distribution.
OpenStack network nodes contain: OpenStack network nodes contain:

View File

@@ -16,7 +16,7 @@ Prerequisites
Before beginning, ensure that you are familiar with the Before beginning, ensure that you are familiar with the
documentation for installing the OpenStack Image API service. documentation for installing the OpenStack Image API service.
See the *Image service* section in the See the *Image service* section in the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install>`_, `Installation Guides <https://docs.openstack.org/ocata/install>`_,
depending on your distribution. depending on your distribution.
.. _glance-api-pacemaker: .. _glance-api-pacemaker:

View File

@@ -2,7 +2,7 @@
Configuring the compute node Configuring the compute node
============================ ============================
The `Installation Tutorials and Guides The `Installation Guides
<https://docs.openstack.org/ocata/install/>`_ <https://docs.openstack.org/ocata/install/>`_
provide instructions for installing multiple compute nodes. provide instructions for installing multiple compute nodes.
To make the compute nodes highly available, you must configure the To make the compute nodes highly available, you must configure the

View File

@@ -12,11 +12,11 @@ The following are the standard hardware requirements:
- Provider networks: See the *Overview -> Networking Option 1: Provider - Provider networks: See the *Overview -> Networking Option 1: Provider
networks* section of the networks* section of the
`Install Tutorials and Guides <https://docs.openstack.org/ocata/install>`_ `Install Guides <https://docs.openstack.org/ocata/install>`_
depending on your distribution. depending on your distribution.
- Self-service networks: See the *Overview -> Networking Option 2: - Self-service networks: See the *Overview -> Networking Option 2:
Self-service networks* section of the Self-service networks* section of the
`Install Tutorials and Guides <https://docs.openstack.org/ocata/install>`_ `Install Guides <https://docs.openstack.org/ocata/install>`_
depending on your distribution. depending on your distribution.
OpenStack does not require a significant amount of resources and the following OpenStack does not require a significant amount of resources and the following

View File

@@ -28,5 +28,5 @@ By default, ``controller1`` handles the caching service. If the host goes down,
For more information about Memcached installation, see the For more information about Memcached installation, see the
*Environment -> Memcached* section in the *Environment -> Memcached* section in the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_ `Installation Guides <https://docs.openstack.org/ocata/install/>`_
depending on your distribution. depending on your distribution.

View File

@@ -6,5 +6,5 @@ You must configure NTP to properly synchronize services among nodes.
We recommend that you configure the controller node to reference We recommend that you configure the controller node to reference
more accurate (lower stratum) servers and other nodes to reference more accurate (lower stratum) servers and other nodes to reference
the controller node. For more information, see the the controller node. For more information, see the
`Installation Tutorials and Guides `Installation Guides
<https://docs.openstack.org/ocata/install/>`_. <https://docs.openstack.org/ocata/install/>`_.

View File

@@ -5,10 +5,10 @@ Installing the operating system
The first step in setting up your highly available OpenStack cluster The first step in setting up your highly available OpenStack cluster
is to install the operating system on each node. is to install the operating system on each node.
Follow the instructions in the *Environment* section of the Follow the instructions in the *Environment* section of the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install>`_ `Installation Guides <https://docs.openstack.org/ocata/install>`_
depending on your distribution. 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 the services that use passwords with important notes about using
them. them.

View File

@@ -6,7 +6,7 @@ Abstract
~~~~~~~~ ~~~~~~~~
This guide describes how to install and configure OpenStack for high 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. and assumes that you are familiar with the material in those guides.
.. important:: .. important::

View File

@@ -11,7 +11,7 @@ Configuring the networking services
Configure networking on each node. See the basic information Configure networking on each node. See the basic information
about configuring networking in the *Networking service* about configuring networking in the *Networking service*
section of the section of the
`Install Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_, `Install Guides <https://docs.openstack.org/ocata/install/>`_,
depending on your distribution. depending on your distribution.
OpenStack network nodes contain: OpenStack network nodes contain:

View File

@@ -16,7 +16,7 @@ Prerequisites
Before beginning, ensure that you are familiar with the Before beginning, ensure that you are familiar with the
documentation for installing the OpenStack Image API service. documentation for installing the OpenStack Image API service.
See the *Image service* section in the See the *Image service* section in the
`Installation Tutorials and Guides <https://docs.openstack.org/ocata/install/>`_, `Installation Guides <https://docs.openstack.org/ocata/install/>`_,
depending on your distribution. depending on your distribution.
.. _glance-api-pacemaker: .. _glance-api-pacemaker:

View File

@@ -6,7 +6,7 @@ The installation of individual OpenStack services is covered in the
Project Installation Guides that are available at the following Project Installation Guides that are available at the following
locations: locations:
* `OpenStack Installation Tutorials and Guides for Pike * `OpenStack Installation Guides for Pike
<https://docs.openstack.org/pike/install/>`_ <https://docs.openstack.org/pike/install/>`_
.. Note that this guide is release independent, so we will add more .. Note that this guide is release independent, so we will add more

View File

@@ -24,7 +24,7 @@
<div class="row docs-toc"> <div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6"> <div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section"> <div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Tutorials</h3> <h3><i class="fa fa-cogs"></i>Installation Guides</h3>
<p> <p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-obs/"> <a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-obs/">
openSUSE and SUSE Linux Enterprise openSUSE and SUSE Linux Enterprise

View File

@@ -25,7 +25,7 @@
<div class="row docs-toc"> <div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6"> <div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section"> <div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Tutorials</h3> <h3><i class="fa fa-cogs"></i>Installation Guide</h3>
<p> <p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-rdo/"> <a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-rdo/">
Red Hat Enterprise Linux and CentOS Red Hat Enterprise Linux and CentOS

View File

@@ -24,7 +24,7 @@
<div class="row docs-toc"> <div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6"> <div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section"> <div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Tutorials</h3> <h3><i class="fa fa-cogs"></i>Installation Guide</h3>
<p> <p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-ubuntu/"> <a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" href="/ocata/install-guide-ubuntu/">
Ubuntu Ubuntu

View File

@@ -28,14 +28,14 @@
<div class="row docs-toc"> <div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6"> <div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section"> <div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Tutorial</h3> <h3><i class="fa fa-cogs"></i>Installation Guide</h3>
<p>The following tutorial provides information about getting started, <p>The following guide provides information about getting started,
setting up your environment, and launching your instance. setting up your environment, and launching your instance.
</p> </p>
<p> <p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" <a class="overview-btn docs-btn" style="width:80%;text-transform:initial;"
href="/install-guide/"> href="/install-guide/">
OpenStack Installation Tutorial OpenStack Installation Guide
</a> </a>
</p> </p>
</div> </div>

View File

@@ -28,14 +28,14 @@
<div class="row docs-toc"> <div class="row docs-toc">
<div class="col-lg-6 col-md-6 col-sm-6"> <div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections services-section"> <div class="docs-link-sections services-section">
<h3><i class="fa fa-cogs"></i>Installation Tutorial</h3> <h3><i class="fa fa-cogs"></i>Installation Guide</h3>
<p>The following tutorial provides information about getting started, <p>The following guide provides information about getting started,
setting up your environment, and launching your instance. setting up your environment, and launching your instance.
</p> </p>
<p> <p>
<a class="overview-btn docs-btn" style="width:80%;text-transform:initial;" <a class="overview-btn docs-btn" style="width:80%;text-transform:initial;"
href="/install-guide/"> href="/install-guide/">
OpenStack Installation Tutorial OpenStack Installation Guide
</a> </a>
</p> </p>
</div> </div>