From 802aa99c1b59ebaa0a178b937f4e61e06a871a56 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Mon, 21 Jun 2021 14:30:29 -0400 Subject: [PATCH] Openstack .. include changes Made paths to include files relative to doc source. This is needed for downstream builds and is good practice for reusability. Fixed some include statements with broken syntax. Added missing section labels to include file. Signed-off-by: Ron Stone Change-Id: I0423c2008445b49e0bb60b9690925041d7acd6f6 Signed-off-by: Ron Stone --- doc/source/_includes/resource-planning.rest | 10 ++++++++++ .../restore-openstack-from-a-backup.rst | 2 +- .../openstack/data-networks-overview.rst | 2 +- .../datanet/openstack/dynamic-vxlan.rst | 16 +++++++--------- doc/source/datanet/openstack/static-vxlan.rst | 4 ++-- .../datanet/openstack/vxlan-data-networks.rst | 2 +- .../openstack-alarm-messages-400s.rst | 4 ++-- .../openstack-alarm-messages-700s.rst | 4 ++-- .../openstack-alarm-messages-800s.rst | 2 +- ...mer-log-messages-270s-virtual-machines.rst | 4 ++-- ...ck-customer-log-messages-401s-services.rst | 2 +- ...mer-log-messages-700s-virtual-machines.rst | 4 ++-- .../openstack-fault-management-overview.rst | 2 +- .../planning/openstack/resource-planning.rst | 19 ++++++++----------- 14 files changed, 41 insertions(+), 36 deletions(-) diff --git a/doc/source/_includes/resource-planning.rest b/doc/source/_includes/resource-planning.rest index e69de29bb..5260bb2d1 100644 --- a/doc/source/_includes/resource-planning.rest +++ b/doc/source/_includes/resource-planning.rest @@ -0,0 +1,10 @@ +.. avs-text-1-begin + +.. avs-text-2-end + + +.. avs-text-2-begin + +.. avs-text-2-end + +.. avs-text-1-end diff --git a/doc/source/backup/openstack/restore-openstack-from-a-backup.rst b/doc/source/backup/openstack/restore-openstack-from-a-backup.rst index 1f776945d..368da1da2 100644 --- a/doc/source/backup/openstack/restore-openstack-from-a-backup.rst +++ b/doc/source/backup/openstack/restore-openstack-from-a-backup.rst @@ -117,4 +117,4 @@ You can restore |prod-os| from a backup with or without Ceph. | | backup_filename=wr-openstack_backup.tgz' | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. include:: ../../_includes/restore-openstack-from-a-backup.rest \ No newline at end of file +.. include:: /_includes/restore-openstack-from-a-backup.rest diff --git a/doc/source/datanet/openstack/data-networks-overview.rst b/doc/source/datanet/openstack/data-networks-overview.rst index b9e04bb02..32531c95b 100644 --- a/doc/source/datanet/openstack/data-networks-overview.rst +++ b/doc/source/datanet/openstack/data-networks-overview.rst @@ -49,4 +49,4 @@ OpenStack Neutron commands, see :ref:`Adding Segmentation Ranges Using the CLI .. only:: partner - .. include:: ../../_includes/data-networks-overview.rest \ No newline at end of file + .. include:: /_includes/data-networks-overview.rest diff --git a/doc/source/datanet/openstack/dynamic-vxlan.rst b/doc/source/datanet/openstack/dynamic-vxlan.rst index 1a56118c3..f76a9c094 100644 --- a/doc/source/datanet/openstack/dynamic-vxlan.rst +++ b/doc/source/datanet/openstack/dynamic-vxlan.rst @@ -33,10 +33,9 @@ for more complex routing requirements but requires IP multicast enabled routers. .. only:: partner - .. include:: ../../_includes/dynamic-vxlan.rest - - :start-after: vswitch-text-1-begin - :end-before: vswitch-text-1-end + .. include:: /_includes/dynamic-vxlan.rest + :start-after: vswitch-text-1-begin + :end-before: vswitch-text-1-end .. figure:: ../figures/eol1510005391750.png @@ -52,10 +51,9 @@ Multicast Endpoint Distribution .. only:: partner - .. include:: ../../_includes/dynamic-vxlan.rest - - :start-after: vswitch-text-1-begin - :end-before: vswitch-text-1-end + .. include:: /_includes/dynamic-vxlan.rest + :start-after: vswitch-text-1-begin + :end-before: vswitch-text-1-end .. _dynamic-vxlan-section-N10054-N1001F-N10001: @@ -94,4 +92,4 @@ segmentation ranges using the |CLI|. For more information on the differences between the dynamic and static |VXLAN| modes, see :ref:`Differences Between Dynamic and Static VXLAN Modes -`. \ No newline at end of file +`. diff --git a/doc/source/datanet/openstack/static-vxlan.rst b/doc/source/datanet/openstack/static-vxlan.rst index 9231cc794..1d08a54c8 100644 --- a/doc/source/datanet/openstack/static-vxlan.rst +++ b/doc/source/datanet/openstack/static-vxlan.rst @@ -20,7 +20,7 @@ to receive the packet in order to reach the |VM|. .. only:: partner - .. include:: ../../_includes/static-vxlan.rest + .. include:: /_includes/static-vxlan.rest :start-after: vswitch-text-1-begin :end-before: vswitch-text-1-end @@ -60,4 +60,4 @@ segmentation ranges using the |CLI|. For more information on the differences between the dynamic and static |VXLAN| modes, see :ref:`Differences Between Dynamic and Static VXLAN Modes -`. \ No newline at end of file +`. diff --git a/doc/source/datanet/openstack/vxlan-data-networks.rst b/doc/source/datanet/openstack/vxlan-data-networks.rst index aa7e56601..c65ac49d0 100644 --- a/doc/source/datanet/openstack/vxlan-data-networks.rst +++ b/doc/source/datanet/openstack/vxlan-data-networks.rst @@ -25,7 +25,7 @@ are included in the outer IP header. .. only:: partner - .. include:: ../../_includes/vxlan-data-networks.rest + .. include:: /_includes/vxlan-data-networks.rest .. _vxlan-data-networks-ul-rzs-kqf-zbb: diff --git a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst index 31e68d73f..6fa9267c9 100644 --- a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-400s.rst @@ -6,7 +6,7 @@ Alarm Messages - 400s ===================== -.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest +.. include:: /_includes/openstack-alarm-messages-xxxs.rest .. list-table:: :widths: 6 15 @@ -52,4 +52,4 @@ Alarm Messages - 400s * - Severity: - M\* * - Proposed Repair Action - - Bring a controller node back in to service, otherwise contact next level of support. \ No newline at end of file + - Bring a controller node back in to service, otherwise contact next level of support. diff --git a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst index de5dde30c..a79896c7d 100644 --- a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-700s.rst @@ -6,7 +6,7 @@ Alarm Messages - 700s ===================== -.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest +.. include:: /_includes/openstack-alarm-messages-xxxs.rest .. _alarm-messages-700s-table-zrd-tg5-v5: @@ -272,4 +272,4 @@ Alarm Messages - 700s - M * - Proposed Repair Action - Migrate instances in an attempt to satisfy the policy; if problem - persists contact next level of support. \ No newline at end of file + persists contact next level of support. diff --git a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst index 573324f68..b3856ac2a 100644 --- a/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst +++ b/doc/source/fault-mgmt/openstack/openstack-alarm-messages-800s.rst @@ -6,7 +6,7 @@ Alarm Messages - 800s ===================== -.. include:: ../../_includes/openstack-alarm-messages-xxxs.rest +.. include:: /_includes/openstack-alarm-messages-xxxs.rest .. _alarm-messages-800s-table-zrd-tg5-v5: diff --git a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst index bf47db52c..b4dccccf9 100644 --- a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-270s-virtual-machines.rst @@ -6,7 +6,7 @@ Customer Log Messages 270s - Virtual Machines ============================================= -.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest +.. include:: /_includes/openstack-customer-log-messages-xxxs.rest .. _customer-log-messages-270s-virtual-machines-table-zgf-jvw-v5: @@ -35,4 +35,4 @@ Customer Log Messages 270s - Virtual Machines | | tenant=.instance= | | +-----------+----------------------------------------------------------------------------------+----------+ -See also :ref:`Customer Log Messages 700s - Virtual Machines ` \ No newline at end of file +See also :ref:`Customer Log Messages 700s - Virtual Machines ` diff --git a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst index f2da7f701..43d224716 100644 --- a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-401s-services.rst @@ -6,7 +6,7 @@ Customer Log Messages 401s - Services ===================================== -.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest +.. include:: /_includes/openstack-customer-log-messages-xxxs.rest .. _customer-log-messages-401s-services-table-zgf-jvw-v5: diff --git a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst index 056acf697..0fa9dd435 100644 --- a/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst +++ b/doc/source/fault-mgmt/openstack/openstack-customer-log-messages-700s-virtual-machines.rst @@ -6,7 +6,7 @@ Customer Log Messages 700s - Virtual Machines ============================================= -.. include:: ../../_includes/openstack-customer-log-messages-xxxs.rest +.. include:: /_includes/openstack-customer-log-messages-xxxs.rest .. _customer-log-messages-700s-virtual-machines-table-zgf-jvw-v5: @@ -477,4 +477,4 @@ Customer Log Messages 700s - Virtual Machines | | subsystem-vim | | +----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------+ -See also :ref:`Customer Log Messages 270s - Virtual Machines ` \ No newline at end of file +See also :ref:`Customer Log Messages 270s - Virtual Machines ` diff --git a/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst b/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst index bd2f8244e..fa48a884f 100644 --- a/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst +++ b/doc/source/fault-mgmt/openstack/openstack-fault-management-overview.rst @@ -21,4 +21,4 @@ Management Protocol)` are available on the |prod| REST APIs, :abbr:`CLIs .. only:: partner - .. include:: ../../_includes/openstack-fault-management-overview.rest \ No newline at end of file + .. include:: /_includes/openstack-fault-management-overview.rest diff --git a/doc/source/planning/openstack/resource-planning.rst b/doc/source/planning/openstack/resource-planning.rst index 629d35f0f..991a145a8 100644 --- a/doc/source/planning/openstack/resource-planning.rst +++ b/doc/source/planning/openstack/resource-planning.rst @@ -28,26 +28,23 @@ Resource Placement .. only:: partner - .. include:: ../../_includes/resource-planning.rest - - :start-after: avs-text-1-begin - :end-before: avs-text-2-end + .. include:: /_includes/resource-planning.rest + :start-after: avs-text-1-begin + :end-before: avs-text-2-end .. only:: partner - .. include:: ../../_includes/resource-planning.rest - - :start-after: avs-text-2-begin - :end-before: avs-text-2-end + .. include:: /_includes/resource-planning.rest + :start-after: avs-text-2-begin + :end-before: avs-text-2-end .. _resource-planning-ul-tcb-ssz-55: .. only:: partner - .. include:: ../../_includes/resource-planning.rest - - :start-after: avs-text-1-end + .. include:: /_includes/resource-planning.rest + :start-after: avs-text-1-end If accessing |PCIe| devices directly from a |VM| using |PCI|-Passthrough or