diff --git a/doc/install-guide-debconf/setup.cfg b/doc/install-guide-debconf/setup.cfg index 236e72ba82..f8e046d092 100644 --- a/doc/install-guide-debconf/setup.cfg +++ b/doc/install-guide-debconf/setup.cfg @@ -3,7 +3,7 @@ name = openstackinstallguide summary = OpenStack Installation Guides author = OpenStack author-email = openstack-docs@lists.openstack.org -home-page = http://docs.openstack.org/ +home-page = https://docs.openstack.org/ classifier = Environment :: OpenStack Intended Audience :: Information Technology diff --git a/doc/install-guide/source/additional-services.rst b/doc/install-guide/source/additional-services.rst index 97cafa0b09..c0202900ad 100644 --- a/doc/install-guide/source/additional-services.rst +++ b/doc/install-guide/source/additional-services.rst @@ -15,7 +15,7 @@ support to manage and provision physical machines. Installation and configuration is documented in the `Bare Metal installation guide -`_. +`_. Container Infrastructure Management service (magnum) ==================================================== @@ -26,7 +26,7 @@ Kubernetes and Mesos available as first class resources in OpenStack. Installation and configuration is documented in the `Container Infrastructure Management installation guide -`_. +`_. Database service (trove) ======================== @@ -36,7 +36,7 @@ database engines. Installation and configuration is documented in the `Database installation guide -`_. +`_. Key Manager service (barbican) ============================== @@ -46,7 +46,7 @@ of secret data such as passphrases, encryption keys, and X.509 certificates. Installation and configuration is documented in the `Key Manager installation guide -`_. +`_. Messaging service (zaqar) ========================= @@ -57,7 +57,7 @@ requiring each component to be always available. Installation and configuration is documented in the `Messaging installation guide -`_. +`_. Object Storage services (swift) =============================== @@ -67,19 +67,19 @@ retrieval through a REST API. Installation and configuration is documented in the `Object Storage installation guide -`_. +`_. Orchestration service (heat) ============================ The Orchestration service (heat) uses a `Heat Orchestration Template (HOT) -`_ +`_ to create and manage cloud resources. Installation and configuration is documented in the `Orchestration installation guide -`_. +`_. Shared File Systems service (manila) ==================================== @@ -89,7 +89,7 @@ or distributed file systems. Installation and configuration is documented in the `Shared File Systems installation guide -`_. +`_. Telemetry Alarming services (aodh) ================================== @@ -99,7 +99,7 @@ event data break the defined rules. Installation and configuration is documented in the `Telemetry Alarming installation guide -`_. +`_. Telemetry Data Collection service (ceilometer) ============================================== @@ -114,4 +114,4 @@ The Telemetry Data Collection services provide the following functions: Installation and configuration is documented in the `Telemetry Data Collection installation guide -`_. +`_. diff --git a/doc/install-guide/source/cinder-backup-install.rst b/doc/install-guide/source/cinder-backup-install.rst index 10acee8952..5d1ca8bd19 100644 --- a/doc/install-guide/source/cinder-backup-install.rst +++ b/doc/install-guide/source/cinder-backup-install.rst @@ -8,7 +8,7 @@ Install and configure the backup service Optionally, install and configure the backup service. For simplicity, this configuration uses the Block Storage node and the Object Storage (swift) driver, thus depending on the -`Object Storage service `_. +`Object Storage service `_. .. note:: diff --git a/doc/install-guide/source/cinder.rst b/doc/install-guide/source/cinder.rst index e01edf56c6..e5cf26c26e 100644 --- a/doc/install-guide/source/cinder.rst +++ b/doc/install-guide/source/cinder.rst @@ -23,4 +23,4 @@ nodes. Depending upon the drivers used, the volume service can run on controller nodes, compute nodes, or standalone storage nodes. For more information, see the -`Configuration Reference `_. +`Configuration Reference `_. diff --git a/doc/install-guide/source/environment-networking-verify.rst b/doc/install-guide/source/environment-networking-verify.rst index bfce3300de..942e2dbe3a 100644 --- a/doc/install-guide/source/environment-networking-verify.rst +++ b/doc/install-guide/source/environment-networking-verify.rst @@ -86,7 +86,7 @@ among the nodes before proceeding further. default. During the installation process, certain steps will fail unless you alter or disable the firewall. For more information about securing your environment, refer to the - `OpenStack Security Guide `__. + `OpenStack Security Guide `__. .. endonly @@ -95,6 +95,6 @@ among the nodes before proceeding further. Your distribution does not enable a restrictive :term:`firewall` by default. For more information about securing your environment, refer to the - `OpenStack Security Guide `__. + `OpenStack Security Guide `__. .. endonly diff --git a/doc/install-guide/source/environment-networking.rst b/doc/install-guide/source/environment-networking.rst index 3266650d77..643fa363a1 100644 --- a/doc/install-guide/source/environment-networking.rst +++ b/doc/install-guide/source/environment-networking.rst @@ -115,7 +115,7 @@ the controller node. default. During the installation process, certain steps will fail unless you alter or disable the firewall. For more information about securing your environment, refer to the - `OpenStack Security Guide `__. + `OpenStack Security Guide `__. .. endonly @@ -124,7 +124,7 @@ the controller node. Your distribution does not enable a restrictive :term:`firewall` by default. For more information about securing your environment, refer to the - `OpenStack Security Guide `__. + `OpenStack Security Guide `__. .. endonly diff --git a/doc/install-guide/source/environment-security.rst b/doc/install-guide/source/environment-security.rst index 01d600146d..843c203f40 100644 --- a/doc/install-guide/source/environment-security.rst +++ b/doc/install-guide/source/environment-security.rst @@ -64,7 +64,7 @@ during installation and operation. In some cases, services perform modifications to the host that can interfere with deployment automation tools such as Ansible, Chef, and Puppet. For example, some OpenStack services add a root wrapper to ``sudo`` that can interfere with security -policies. See the `OpenStack Administrator Guide `__ for more information. diff --git a/doc/install-guide/source/environment.rst b/doc/install-guide/source/environment.rst index f140a8d04b..06a5b16e56 100644 --- a/doc/install-guide/source/environment.rst +++ b/doc/install-guide/source/environment.rst @@ -11,7 +11,7 @@ Although most environments include Identity, Image service, Compute, at least one networking service, and the Dashboard, the Object Storage service can operate independently. If your use case only involves Object Storage, you can skip to `Object Storage Installation Guide -`_ +`_ after configuring the appropriate nodes for it. You must use an account with administrative privileges to configure each node. @@ -71,7 +71,7 @@ of nested VMs. interface. For more information about system requirements, see the `OpenStack -Operations Guide `_. +Operations Guide `_. .. toctree:: :maxdepth: 1 diff --git a/doc/install-guide/source/glance-verify.rst b/doc/install-guide/source/glance-verify.rst index c82f17fdf5..2db21dda9b 100644 --- a/doc/install-guide/source/glance-verify.rst +++ b/doc/install-guide/source/glance-verify.rst @@ -7,10 +7,10 @@ Linux image that helps you test your OpenStack deployment. For more information about how to download and build images, see `OpenStack Virtual Machine Image Guide -`__. +`__. For information about how to manage images, see the `OpenStack End User Guide -`__. +`__. .. note:: @@ -75,12 +75,12 @@ For information about how to manage images, see the For information about the :command:`openstack image create` parameters, see `Create or update an image (glance) - `__ + `__ in the ``OpenStack User Guide``. For information about disk and container formats for images, see `Disk and container formats for images - `__ + `__ in the ``OpenStack Virtual Machine Image Guide``. .. note:: diff --git a/doc/install-guide/source/horizon-next-steps.rst b/doc/install-guide/source/horizon-next-steps.rst index 24be809306..c5638a1a9a 100644 --- a/doc/install-guide/source/horizon-next-steps.rst +++ b/doc/install-guide/source/horizon-next-steps.rst @@ -15,11 +15,11 @@ complete the following tasks: * Customize your dashboard. See section `Customize and configure the Dashboard - `__. + `__. * Set up session storage. See `Set up session storage for the dashboard - `__. + `__. * To use the VNC client with the dashboard, the browser must support HTML5 Canvas and HTML5 WebSockets. diff --git a/doc/install-guide/source/keystone-openrc.rst b/doc/install-guide/source/keystone-openrc.rst index 78a054b5cf..7de779d399 100644 --- a/doc/install-guide/source/keystone-openrc.rst +++ b/doc/install-guide/source/keystone-openrc.rst @@ -7,7 +7,7 @@ command options to interact with the Identity service via the OpenStack supports simple client environment scripts also known as OpenRC files. These scripts typically contain common options for all clients, but also support unique options. For more information, see the -`OpenStack End User Guide `__. Creating the scripts diff --git a/doc/install-guide/source/launch-instance-cinder.rst b/doc/install-guide/source/launch-instance-cinder.rst index 4ab0799a79..050b61c958 100644 --- a/doc/install-guide/source/launch-instance-cinder.rst +++ b/doc/install-guide/source/launch-instance-cinder.rst @@ -139,7 +139,7 @@ Attach the volume to an instance For more information about how to manage volumes, see the `Manage volumes -`__ +`__ in OpenStack End User Guide. Return to :ref:`launch-instance`. diff --git a/doc/install-guide/source/launch-instance-provider.rst b/doc/install-guide/source/launch-instance-provider.rst index c023731049..815395bb1d 100644 --- a/doc/install-guide/source/launch-instance-provider.rst +++ b/doc/install-guide/source/launch-instance-provider.rst @@ -268,7 +268,7 @@ Access the instance remotely If your instance does not launch or seem to work as you expect, see the `Instance Boot Failures -`__ +`__ section in OpenStack Operations Guide for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance-selfservice.rst b/doc/install-guide/source/launch-instance-selfservice.rst index 7da55a4493..2da502c07a 100644 --- a/doc/install-guide/source/launch-instance-selfservice.rst +++ b/doc/install-guide/source/launch-instance-selfservice.rst @@ -309,7 +309,7 @@ Access the instance remotely If your instance does not launch or seem to work as you expect, see the `Instance Boot Failures -`__ +`__ section in OpenStack Operations Guide for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance.rst b/doc/install-guide/source/launch-instance.rst index fedc06c785..57a026394a 100644 --- a/doc/install-guide/source/launch-instance.rst +++ b/doc/install-guide/source/launch-instance.rst @@ -14,10 +14,10 @@ tools on the controller node. However, you can follow the instructions on any host that the tools are installed. For more information on the CLI tools, see the `OpenStack End User Guide -`__. +`__. To use the dashboard, see the `OpenStack End User Guide -`__. +`__. .. _launch-instance-networks: @@ -220,7 +220,7 @@ If your environment includes the Orchestration service, you can create a stack that launches an instance. For more information, see the -`Orchestration installation guide `_. +`Orchestration installation guide `_. Shared File Systems ------------------- @@ -230,4 +230,4 @@ a share and mount it in an instance. For more information, see the `Shared File Systems installation guide -`_. +`_. diff --git a/doc/install-guide/source/neutron.rst b/doc/install-guide/source/neutron.rst index db6035ba6a..4cd61a4425 100644 --- a/doc/install-guide/source/neutron.rst +++ b/doc/install-guide/source/neutron.rst @@ -20,4 +20,4 @@ service (neutron) using the :ref:`provider networks ` or For more information about the Networking service including virtual networking components, layout, and traffic flows, see the -`OpenStack Networking Guide `__. +`OpenStack Networking Guide `__. diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 4841718cb9..5726778206 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -48,9 +48,9 @@ follows: network instead of a dedicated network. For more information on production architectures, see the -`Architecture Design Guide `__, -`OpenStack Operations Guide `__, and -`OpenStack Networking Guide `__. +`Architecture Design Guide `__, +`OpenStack Operations Guide `__, and +`OpenStack Networking Guide `__. .. _figure-hwreqs: