install-guide: move note into file and include note from file

The "Default configuration files vary by distribution." note is
duplicated in a lot of files. This patch moves this note into a separate
file and includes this file in all files using this note.

Change-Id: Ie61e378a217539259180f2e56282b137dd8aa30a

doc/install-guide/source/conf.py

@@ -95,7 +95,8 @@ html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag}
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['common/cli*', 'common/nova*',
-                    'common/log_in_dashboard.rst']
+                    'common/log_in_dashboard.rst',
+                    'shared/note_configuration_vary_by_distribution.rst']
 if tags.has('debian'):  # noqa
     exclude_patterns.append('index.rst')
 else:

doc/install-guide/source/glance-install.rst

@@ -133,13 +133,7 @@ To install and configure the Image service components
 
 .. only:: obs or rdo or ubuntu
 
-   .. note::
-
-      Default configuration files vary by distribution. You might need
-      to add these sections and options rather than modifying existing
-      sections and options. Also, an ellipsis (...) in the configuration
-      snippets indicates potential default configuration options that you
-      should retain.
+   .. include:: shared/note_configuration_vary_by_distribution.rst
 
 .. only:: obs
 

doc/install-guide/source/keystone-install.rst

@@ -56,12 +56,7 @@ database and an administration token.
 
    **To install and configure the Identity service components**
 
-   .. note::
-      Default configuration files vary by distribution. You might need to
-      add these sections and options rather than modifying existing
-      sections and options. Also, an ellipsis (...) in the configuration
-      snippets indicates potential default configuration options that you
-      should retain.
+   .. include:: shared/note_configuration_vary_by_distribution.rst
 
    .. note::
       In Kilo, the keystone project deprecates Eventlet in favor of a WSGI

doc/install-guide/source/neutron-compute-install.rst

@@ -77,13 +77,7 @@ To configure the Networking common components
 The Networking common component configuration includes the
 authentication mechanism, message queue, and plug-in.
 
-.. note::
-
-   Default configuration files vary by distribution. You might need to
-   add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 Edit the ``/etc/neutron/neutron.conf`` file.
 

doc/install-guide/source/neutron-controller-install-option1.rst

@@ -86,13 +86,7 @@ Install the networking components
    authentication mechanism, message queue, topology change notifications,
    and plug-in.
 
-   .. note::
-
-      Default configuration files vary by distribution. You might need to
-      add these sections and options rather than modifying existing
-      sections and options. Also, an ellipsis (...) in the configuration
-      snippets indicates potential default configuration options that you
-      should retain.
+   .. include:: shared/note_configuration_vary_by_distribution.rst
 
    Edit the ``/etc/neutron/neutron.conf`` file.
 

doc/install-guide/source/nova-compute-install.rst

@@ -24,13 +24,7 @@ scale your environment with additional compute nodes.
 To install and configure the Compute hypervisor components
 ----------------------------------------------------------
 
-.. note::
-
-   Default configuration files vary by distribution. You might need
-   to add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 .. only:: obs
 

doc/install-guide/source/nova-controller-install.rst

@@ -118,13 +118,7 @@ create a database, service credentials, and API endpoint.
 To install and configure Compute controller components
 ------------------------------------------------------
 
-.. note::
-
-   Default configuration files vary by distribution. You might need
-   to add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 .. only:: obs
 

doc/install-guide/source/shared/note_configuration_vary_by_distribution.rst

@@ -0,0 +1,7 @@
+.. note::
+
+   Default configuration files vary by distribution. You might need
+   to add these sections and options rather than modifying existing
+   sections and options. Also, an ellipsis (``...``) in the configuration
+   snippets indicates potential default configuration options that you
+   should retain.

doc/install-guide/source/swift-controller-node.rst

@@ -105,13 +105,7 @@ create service credentials and an API endpoint.
 To install and configure the controller node components
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. note::
-
-   Default configuration files vary by distribution. You might need
-   to add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 #. Install the packages:
 

doc/install-guide/source/swift-finalize-installation.rst

@@ -4,13 +4,7 @@ Finalize installation
 
 **Configure hashes and default storage policy**
 
-.. note::
-
-   Default configuration files vary by distribution. You might need
-   to add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 .. only:: ubuntu or rdo or debian
 

doc/install-guide/source/swift-storage-node.rst

@@ -178,13 +178,8 @@ a separate network for replication. For more information, see
 
 Install and configure storage node components
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. note::
 
-   Default configuration files vary by distribution. You might need
-   to add these sections and options rather than modifying existing
-   sections and options. Also, an ellipsis (...) in the configuration
-   snippets indicates potential default configuration options that you
-   should retain.
+.. include:: shared/note_configuration_vary_by_distribution.rst
 
 .. note::