TOC structure changes

Conditionalized use of "Contents" heading in Kubernetes and
OpenStack subindexes.
Make "Contents" a common include, overwritable per book
Conditionally pull in kubernetes and OpenStack descriptions from
each book index to kubernetes/index and openstack/index for partner
use
Deleted index.rs1 topics from DITA import

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I857a1dbb567a0bf609b449e8260b2f8801a339fb
Signed-off-by: Ron Stone <ronald.stone@windriver.com>

doc/source/_includes/toc-contents.rest

@@ -0,0 +1,3 @@
+.. ========
+.. Contents
+.. ========

doc/source/_includes/toc-title-admintasks-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-admintasks-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-backup-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-backup-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-datanet-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-datanet-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-dc-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-deploy-kub.rest

@@ -0,0 +1 @@
+.. .. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-deploy-os.rest

@@ -0,0 +1 @@
+.. .. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-fm-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-fm-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-guest-kub.rest

@@ -0,0 +1,3 @@
+=====================
+Container Integration
+=====================

doc/source/_includes/toc-title-guest-os.rest

@@ -0,0 +1,3 @@
+=========================
+OpenStack VNF Integration
+=========================

doc/source/_includes/toc-title-node-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-node-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-planning-kub.rest

@@ -0,0 +1 @@
+.. .. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-planning-os.rest

@@ -0,0 +1 @@
+.. .. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-security-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-security-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-storage-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-storage-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-sys-conf-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-sys-conf-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-updates-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-updates-os.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/_includes/toc-title-usertasks-kub.rest

@@ -0,0 +1 @@
+.. include:: /_includes/toc-contents.rest

doc/source/admintasks/index.rst

@@ -4,13 +4,17 @@
 Admin Tasks
 ===========
 
-The |prod-long| Kubernetes administration tutorials provide working examples
-of common administrative tasks.
-
 ----------
 Kubernetes
 ----------
 
+.. kub-begin
+
+The |prod-long| Kubernetes administration tutorials provide working examples
+of common administrative tasks.
+
+.. kub-end
+
 .. toctree::
     :maxdepth: 2
 
@@ -20,9 +24,12 @@ Kubernetes
 StarlingX OpenStack
 -------------------
 
+.. os-begin
+
 |prod| supports configuring Nova's dedicated and shared CPU pools on a per
 openstack-compute host basis.
 
+.. os-end
 
 .. toctree::
     :maxdepth: 2

doc/source/admintasks/kubernetes/index.rst

@@ -1,13 +1,13 @@
-.. _admin-tasks-title:
+.. _admintasks-kubernetes-index:
 
 
-========
+.. include:: /_includes/toc-title-admintasks-kub.rest
-Contents
-========
 
---------------------
+.. only:: partner
-StarlingX Kubernetes
+
---------------------
+   .. include:: /admintasks/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 .. toctree::
    :maxdepth: 1

doc/source/admintasks/openstack/index.rst

@@ -1,10 +1,12 @@
--------------------
+.. _admintasks-openstack-index:
-StarlingX OpenStack
--------------------
 
-===========
+.. include:: /_includes/toc-title-admintasks-os.rest
-Admin Tasks
+
-===========
+.. only:: partner
+
+   .. include:: /admintasks/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. toctree::
    :maxdepth: 1

doc/source/backup/kubernetes/index.rs1

@@ -1,17 +0,0 @@
-=====================================
-|prod-long| System Backup and Restore
-=====================================
-
--   System Data Backup
-
-    -   :ref:`Backing Up Platform System Data <backing-up-cloud-platform-system-data>`
-
-        -   :ref:`Running Ansible Backup Playbook Locally on the Controller <running-ansible-backup-playbook-locally-on-the-controller>`
-        -   :ref:`Running Ansible Backup Playbook Remotely <running-ansible-backup-playbook-remotely>`
-
-
--   System Data and Storage Restore
-
-    -   :ref:`Restoring Platform System Data and Storage <restoring-cloud-platform-system-data-and-storage>`
-    -   :ref:`Running Restore Playbook Locally on the Controller <running-restore-playbook-locally-on-the-controller>`
-    -   :ref:`Running Ansible Restore Playbook Remotely <system-backup-running-ansible-restore-playbook-remotely>`

doc/source/backup/kubernetes/index.rst

@@ -3,13 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-----------
+.. include:: /_includes/toc-title-backup-kub.rest
-Kubernetes
-----------
-
-==================
-Backup and Restore
-==================
 
 -------------
 System backup

doc/source/backup/openstack/index.rst

@@ -1,7 +1,5 @@
 
----------
+.. include:: /_includes/toc-title-backup-kub.rest
-OpenStack
----------
 
 ==================
 Backup and Restore

doc/source/datanet/index.rst

@@ -10,9 +10,13 @@ Data Networks
 Kubernetes
 ----------
 
+.. kub-begin
+
 |prod-long| data network management allows you to model the L2 networks that
 are attached to node data, pci-sriov and pci-passthrough interfaces.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -23,9 +27,13 @@ are attached to node data, pci-sriov and pci-passthrough interfaces.
 OpenStack
 ---------
 
+.. os-begin
+
 Data networks are used to model the L2 Networks that nodes' data, pci-sriov
 and pci-passthrough interfaces attach to.
 
+.. os-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/datanet/kubernetes/index.rst

@@ -2,9 +2,13 @@
 
 .. _datanet_kubernetes_index:
 
-========
+.. include:: /_includes/toc-title-datanet-kub.rest
-Overview
+
-========
+.. only:: partner
+
+   .. include:: /datanet/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 .. toctree::
    :maxdepth: 1

doc/source/datanet/openstack/index.rst

@@ -1,11 +1,12 @@
-.. Data networks file, created by
+.. _datanet_openstack_index:
-   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-========
+.. include:: /_includes/toc-title-datanet-os.rest
-Contents
+
-========
+.. only:: partner
+
+   .. include:: /datanet/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. toctree::
    :maxdepth: 1

doc/source/deploy/index.rst

@@ -4,6 +4,8 @@
 Deployment Configurations
 =========================
 
+.. kub-begin
+
 A variety of |prod-long| deployment configuration options are supported.
 
 **All-in-one Simplex**
@@ -23,6 +25,8 @@ A variety of |prod-long| deployment configuration options are supported.
     A two node HA controller node cluster with a 2-9 node Ceph storage
     cluster, managing up to 200 worker nodes.
 
+.. kub-end
+
 .. toctree::
     :maxdepth: 2
 

doc/source/deploy/kubernetes/index.rst

@@ -1,11 +1,15 @@
-.. Deployment Configurations file, created by
+.. _deploy-kubernetes-index:
-   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-========
+
-Contents
+.. only:: starlingx
-========
+
+   .. include:: /_includes/toc-title-deploy-kub.rest
+
+.. only:: partner
+
+   .. include:: /deploy/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 .. toctree::
    :maxdepth: 1

doc/source/dist_cloud/index.rst

@@ -5,10 +5,14 @@
 Distributed Cloud
 =================
 
+.. kub-begin
+
 |prod-long| |prod-dc| configuration supports an edge computing solution
 by providing central management and orchestration for a geographically
 distributed network of |prod| systems.
 
+.. kub-end
+
 .. toctree::
     :maxdepth: 2
 

doc/source/dist_cloud/kubernetes/index.rst

@@ -1,9 +1,13 @@
 .. _dist-cloud-kubernetes-index:
 
 
-========
+.. include:: /_includes/toc-title-dc-kub.rest
-Contents
+
-========
+.. only:: partner
+
+   .. include:: /dist_cloud/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ------------
 Introduction

doc/source/fault-mgmt/index.rst

@@ -11,6 +11,10 @@ Fault Management
 StarlingX Kubernetes
 --------------------
 
+.. kub-begin
+
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -20,12 +24,16 @@ StarlingX Kubernetes
 StarlingX OpenStack
 -------------------
 
+.. os-begin
+
 |prod-os| is a containerized application running on top of |prod|.
 
 This section provides the list of OpenStack related Alarms and Customer Logs
 that are monitored and reported for the |prod-os| application through the
 |prod| fault management interfaces.
 
+.. os-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/fault-mgmt/kubernetes/index.rs1

@@ -1,67 +0,0 @@
-============================
-|prod-long| Fault Management
-============================
-
--   Fault Management Overview
-
-    -   :ref:`Fault Management Overview <fault-management-overview>`
-
--   The Global Alarm Banner
-
-    -   :ref:`The Global Alarm Banner <the-global-alarm-banner>`
-
--   Viewing Active Alarms
-
-    -   :ref:`Viewing Active Alarms Using Horizon <viewing-active-alarms-using-horizon>`
-    -   :ref:`Viewing Active Alarms Using the CLI <viewing-active-alarms-using-the-cli>`
-    -   :ref:`Viewing Alarm Details Using the CLI <viewing-alarm-details-using-the-cli>`
-
--   Viewing the Event Log
-
-    -   :ref:`Viewing the Event Log Using Horizon <viewing-the-event-log-using-horizon>`
-    -   :ref:`Viewing the Event Log Using the CLI <viewing-the-event-log-using-the-cli>`
-
--   Deleting an Alarm
-
-    -   :ref:`Deleting an Alarm Using the CLI <deleting-an-alarm-using-the-cli>`
-
--   Events Suppression
-
-    -   :ref:`Events Suppression Overview <events-suppression-overview>`
-    -   :ref:`Suppressing and Unsuppressing Events <suppressing-and-unsuppressing-events>`
-    -   :ref:`Viewing Suppressed Alarms Using the CLI <viewing-suppressed-alarms-using-the-cli>`
-    -   :ref:`Suppressing an Alarm Using the CLI <suppressing-an-alarm-using-the-cli>`
-    -   :ref:`Unsuppressing an Alarm Using the CLI <unsuppressing-an-alarm-using-the-cli>`
-
--   CLI Commands and Paged Output
-
-    -   :ref:`CLI Commands and Paged Output <cli-commands-and-paged-output>`
-
--   SNMP
-
-    -   :ref:`SNMP Overview <snmp-overview>`
-    -   :ref:`Enabling SNMP Support <enabling-snmp-support>`
-    -   :ref:`Traps <traps>`
-    -   :ref:`SNMP Event Table <snmp-event-table>`
-    -   :ref:`Setting SNMP Identifying Information <setting-snmp-identifying-information>`
-
--   :ref:`Troubleshooting Log Collection <troubleshooting-log-collection>`
--   |prod| Alarm Messages
-
-    -   :ref:`Alarm Messages Overview <alarm-messages-overview>`
-    -   :ref:`100 Series Alarm Messages <100-series-alarm-messages>`
-    -   :ref:`200 Series Alarm Messages <200-series-alarm-messages>`
-    -   :ref:`300 Series Alarm Messages <300-series-alarm-messages>`
-    -   :ref:`400 Series Alarm Messages <400-series-alarm-messages>`
-    -   :ref:`500 Series Alarm Messages <500-series-alarm-messages>`
-    -   :ref:`750 Series Alarm Messages <750-series-alarm-messages>`
-    -   :ref:`800 Series Alarm Messages <800-series-alarm-messages>`
-    -   :ref:`900 Series Alarm Messages <900-series-alarm-messages>`
-
--   |prod| Customer Log Messages
-
-    -   :ref:`200 Series Maintenance Customer Log Messages <200-series-maintenance-customer-log-messages>`
-    -   :ref:`400 Series Customer Log Messages <400-series-customer-log-messages>`
-    -   :ref:`900 Series Orchestration Customer Log Messages <900-series-orchestration-customer-log-messages>`
-
-

doc/source/fault-mgmt/kubernetes/index.rst

@@ -1,11 +1,12 @@
-.. Fault Management file, created by
+.. _fault-mgmt-kubernetes-index:
-   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-========
+.. include:: /_includes/toc-title-fm-kub.rest
-Contents
+
-========
+.. only:: partner
+
+   .. include:: /fault-mgmt/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 .. toctree::
    :maxdepth: 1

doc/source/fault-mgmt/openstack/index.rst

@@ -1,11 +1,12 @@
-.. Fault Management file, created by
+.. _fault-mgmt-openstack-index:
-   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-========
+.. include:: /_includes/toc-title-fm-os.rest
-Contents
+
-========
+.. only:: partner
+
+   .. include:: /fault-mgmt/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. toctree::
    :maxdepth: 1

doc/source/guest_integration/index.rst

@@ -1,7 +1,4 @@
-.. Fault Management file, created by
+.. _guest-integration-index:
-   sphinx-quickstart on Thu Sep  3 15:14:59 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
 =================
 Guest Integration
@@ -11,10 +8,14 @@ Guest Integration
 Kubernetes container integration
 --------------------------------
 
+.. kub-begin
+
 |prod-long| supports applications that rely on |PTP| for synchronization. These
 applications are able to receive |PTP| status notifications from
 |prod-long| hosting the application.
 
+.. kub-end
+
 .. toctree::
     :maxdepth: 2
 
@@ -24,10 +25,14 @@ applications are able to receive |PTP| status notifications from
 OpenStack VNF integration
 -------------------------
 
+.. os-begin
+
 The |VNF| Integration document contains information specific to |VNF| or
 |VM| application writers that assists them with integrating their
 application on |prod-os|.
 
+.. os-end
+
 .. toctree::
     :maxdepth: 2
 

doc/source/guest_integration/kubernetes/index.rst

@@ -1,6 +1,12 @@
-=====================
+.. _guest-kubernetes-index:
-Container Integration
+
-=====================
+.. include:: /_includes/toc-title-guest-kub.rest
+
+.. only:: partner
+
+   .. include:: /guest_integration/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ----------------
 PTP Notification

doc/source/guest_integration/openstack/index.rst

@@ -1,6 +1,12 @@
-=========================
+.. _guest-openstack-index:
-OpenStack VNF Integration
+
-=========================
+.. include:: /_includes/toc-title-guest-os.rest
+
+.. only:: partner
+
+   .. include:: /guest_integration/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. only:: starlingx
 
@@ -32,12 +38,12 @@ Virtual Network Interfaces
 
    standard-virtio-backed-with-vhost-support
    use-a-vif-model-when-creating-ports
-   
+
 --------------------
 Use Host's PTP Clock
 --------------------
 
 .. toctree::
    :maxdepth: 1
-   
+
    configure-kvm-virtual-ptp-driver

doc/source/node_management/index.rst

@@ -6,6 +6,8 @@ Node Management
 Kubernetes
 ----------
 
+.. kub-begin
+
 You can perform |prod-long| node management of worker hosts that comprise
 resource pools for hosting guest applications.
 
@@ -33,6 +35,8 @@ Complete instructions for adding a worker node are provided in the
 `StarlingX Installation and Deployment Guide
 <https://docs.starlingx.io/deploy_install_guides/index.html>`__.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -42,10 +46,14 @@ Complete instructions for adding a worker node are provided in the
 OpenStack
 ---------
 
+.. os-begin
+
 You can add OpenStack compute nodes to an existing |AIO| Duplex system,
 and use labels to identify OpenStack Nodes.
 
-Guidelines for VMs in a duplex system remain unchanged.
+Guidelines for |VMs| in a duplex system remain unchanged.
+
+.. os-end
 
 *****************************
 Add an OpenStack compute node

doc/source/node_management/kubernetes/index.rst

@@ -1,6 +1,13 @@
-========
+
-Contents
+.. _node-mgmt-kubernetes-index:
-========
+
+.. include:: /_includes/toc-title-node-kub.rest
+
+.. only:: partner
+
+   .. include:: /node_management/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ------------
 Introduction

doc/source/node_management/openstack/index.rst

@@ -1,6 +1,13 @@
-========
+
-Contents
+.. _node-mgmt-openstack-index:
-========
+
+.. include:: /_includes/toc-title-node-os.rest
+
+.. only:: partner
+
+   .. include:: /node_management/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. toctree::
    :maxdepth: 1
@@ -9,7 +16,6 @@ Contents
    adding-compute-nodes-to-an-existing-duplex-system
    using-labels-to-identify-openstack-nodes
 
-
 -------------------------
 PCI Device Access for VMs
 -------------------------

doc/source/planning/index.rst

@@ -11,6 +11,8 @@ Planning
 Kubernetes
 ----------
 
+.. kub-begin
+
 |prod| platform planning helps ensure that the requirements of your containers,
 and the requirements of your cloud administration and operations teams can be
 met. It ensures proper integration of a |prod| into the target data center or
@@ -19,6 +21,8 @@ telecom office, and helps you plan up front for future cloud growth.
 Planning your |prod| installation is a prerequisite for further |prod-os|
 installation planning.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -28,9 +32,13 @@ installation planning.
 OpenStack
 ---------
 
+.. os-begin
+
 |prod-os| is installed as an application in a deployed |prod| environment and
 requires additional network, storage, security and resource planning.
 
+.. os-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/planning/kubernetes/index.rst

@@ -1,8 +1,12 @@
 .. _planning_kubernetes_index:
 
-----------
+.. include:: /_includes/toc-title-planning-kub.rest
-Kubernetes
+
-----------
+.. only:: partner
+
+   .. include:: /planning/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ************
 Introduction

doc/source/planning/openstack/index.rst

@@ -1,7 +1,13 @@
 
----------
+.. _planning-openstack-index:
-OpenStack
+
----------
+.. include:: /_includes/toc-title-planning-os.rest
+
+.. only:: partner
+
+   .. include:: /planning/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 ================
 Network planning

doc/source/security/index.rst

@@ -6,8 +6,9 @@ Security
 Kubernetes
 ----------
 
-|prod-long| security encompasses a broad number of features.
+.. kub-begin
 
+|prod-long| security encompasses a broad number of features.
 
 .. _overview-of-starlingx-security-ul-ezc-k5f-p3b:
 
@@ -28,6 +29,11 @@ Kubernetes
 
 -   Signed software updates
 
+.. kub-end
+
+Contents:
+---------
+
 .. toctree::
    :maxdepth: 2
 
@@ -37,7 +43,9 @@ Kubernetes
 OpenStack
 ---------
 
-.. check what put here
+.. os-begin
+
+.. os-end
 
 .. toctree::
     :maxdepth: 2

doc/source/security/kubernetes/index.rst

@@ -1,6 +1,12 @@
-========
+.. _security-kubernetes-index:
-Contents
+
-========
+.. include:: /_includes/toc-title-security-kub.rest
+
+.. only:: partner
+
+   .. include:: /security/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ***************
 System Accounts

doc/source/security/openstack/index.rst

@@ -1,6 +1,13 @@
-========
+
-Contents
+.. _security-openstack-index:
-========
+
+.. include:: /_includes/toc-title-security-os.rest
+
+.. only:: partner
+
+   .. include:: /security/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 -----------------
 Keystone Accounts

doc/source/security/openstack/openstack-keystone-accounts.rst

@@ -18,5 +18,3 @@ API.
 
 .. seealso::
     :ref:`System Account Password Rules <security-system-account-password-rules>`
-
-

doc/source/storage/index.rst

@@ -1,15 +1,20 @@
 =======
 Storage
 =======
+
 ----------
 Kubernetes
 ----------
 
+.. kub-begin
+
 |prod| uses storage resources on the controller and worker hosts, and on
 storage hosts if they are present.The |prod| storage configuration is highly
 flexible. The specific configuration depends on the type of system installed,
 and the requirements of the system.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -19,6 +24,14 @@ and the requirements of the system.
 OpenStack
 ---------
 
+.. os-begin
+
+|prod-os| is a containerized application running on top of the |prod-long|.
+
+The storage management of hosts is not specific to |prod-os|.
+
+.. os-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/storage/kubernetes/index.rst

@@ -1,6 +1,12 @@
-========
+.. _storage-kubernetes-index:
-Contents
+
-========
+.. include:: /_includes/toc-title-storage-kub.rest
+
+.. only:: partner
+
+   .. include:: /storage/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 --------
 Overview

doc/source/storage/openstack/index.rst

@@ -1,8 +1,12 @@
-========
+.. _storage-openstack-index:
-Contents
-========
 
-.. check what put here
+.. include:: /_includes/toc-title-storage-os.rest
+
+.. only:: partner
+
+   .. include:: /storage/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 .. toctree::
    :maxdepth: 1

doc/source/storage/openstack/storage-configuration-and-management-overview.rst

@@ -13,6 +13,6 @@ information, see |prod-long| System Configuration:
 
 .. xbooklink :ref:`System Configuration Management Overview <system-configuration-management-overview>`.
 
-This chapter covers concepts and additional considerations related to storage
+This section covers concepts and additional considerations related to storage
 management that are specific to |prod-os|.
 

doc/source/system_configuration/index.rst

@@ -9,10 +9,14 @@ System Configuration
 StarlingX Kubernetes
 --------------------
 
+.. kub-begin
+
 |prod-long| system configuration can be done any time after installation
 to change system configuration data specified during system installation,
 and to set additional system configuration data.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -22,12 +26,16 @@ and to set additional system configuration data.
 StarlingX OpenStack
 -------------------
 
+.. os-begin
+
 |prod-os| is installed and managed as an Armada application.
 
 Armada Applications are a set of one or more interdependent Application Helm
-Charts. In the case of |prod|, there is generally a Helm Chart for every
+charts. In the case of |prod|, there is generally a Helm chart for every
 OpenStack service.
 
+.. os-end
+
 .. toctree::
    :maxdepth: 3
 

doc/source/system_configuration/kubernetes/index.rst

@@ -1,8 +1,12 @@
 .. _sysconf_kubernetes_index:
 
-==========
+.. include:: /_includes/toc-title-sys-conf-kub.rest
-Kubernetes
+
-==========
+.. only:: partner
+
+   .. include:: /system_configuration/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ----------------------
 Timezone Configuration

doc/source/system_configuration/openstack/index.rst

@@ -1,8 +1,12 @@
 .. _sysconf_openstack_index:
 
-===================
+.. include:: /_includes/toc-title-sys-conf-os.rest
-StarlingX OpenStack
+
-===================
+.. only:: partner
+
+   .. include:: /system_configuration/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 -------------------------------------------------------
 Configure OpenStack Services Using Helm Chart Overrides

doc/source/updates/index.rst

@@ -6,9 +6,13 @@ Updates and Upgrades
 Kubernetes
 ----------
 
+.. kub-begin
+
 Kubernetes version upgrade cloud orchestration allows the Kubernetes version on
 all hosts of an entire |prod-long| cloud to be updated with a single operation.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 
@@ -18,10 +22,14 @@ all hosts of an entire |prod-long| cloud to be updated with a single operation.
 Openstack
 ---------
 
+.. os-begin
+
 The system application-update -n |prefix|-openstack -v <new-app-version>
 command is used for corrective content \(bug fixes\) -type updates to the
 running containerized openstack application.
 
+.. os-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/updates/kubernetes/index.rst

@@ -1,7 +1,13 @@
 
-==========
+.. _updates_kubernetes_index:
-Kubernetes
+
-==========
+.. include:: /_includes/toc-title-updates-kub.rest
+
+.. only:: partner
+
+   .. include:: /updates/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 ------------
 Introduction

doc/source/updates/openstack/index.rst

@@ -1,7 +1,13 @@
 
----------
+.. _updates_openstack_index:
-OpenStack
+
----------
+.. include:: /_includes/toc-title-updates-os.rest
+
+.. only:: partner
+
+   .. include:: /updates/index.rst
+      :start-after: os-begin
+      :end-before: os-end
 
 ===============
 Software Update

doc/source/usertasks/index.rst

@@ -6,9 +6,13 @@ User Tasks
 Kubernetes
 ----------
 
+.. kub-begin
+
 The |prod-long| Kubernetes user tutorials provide working examples of common
 end-user tasks.
 
+.. kub-end
+
 .. toctree::
    :maxdepth: 2
 

doc/source/usertasks/kubernetes/index.rst

@@ -1,6 +1,12 @@
-========
+.. _usertasks-kubernetes-index:
-Contents
+
-========
+.. include:: /_includes/toc-title-usertasks-kub.rest
+
+.. only:: partner
+
+   .. include:: /usertasks/index.rst
+      :start-after: kub-begin
+      :end-before: kub-end
 
 -------------
 System access