Add nav sections/folders for config guides and admin guides

- New nav section: Configuration, topic specific config guides
- New nav section: Operation Guides, task specific guides
- New nav item: CLI Reference
- Sections organized by general, kubernetes, openstack
- Stubb pages added for all top level topics in sections, with
  link to associated StoryBoard story

Change-Id: I59f58adbb27bf4d65755cddc40a8ec565fb949f1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-11-08 16:26:56 -08:00
parent 437179ebff
commit 22f4e7843e
32 changed files with 532 additions and 3 deletions

View File

@ -0,0 +1,12 @@
=============
CLI Reference
=============
This is a stub page for the topic: CLI Reference. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add CLI Reference <https://storyboard.openstack.org/#!/story/2006888>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.

View File

@ -0,0 +1,16 @@
======================
Branding Configuration
======================
This is a stub page for the topic: Branding Configuration. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Branding Config guide <https://storyboard.openstack.org/#!/story/2006868>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=========================
Certificate Configuration
=========================
This is a stub page for the topic: Certificate Configuration. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Certificate Configuration and Management guide <https://storyboard.openstack.org/#!/story/2006866>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==================
Host Configuration
==================
This is a stub page for the topic: Host Configuration. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add Host Configuration Guide <https://storyboard.openstack.org/#!/story/2006864>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,36 @@
=============
Configuration
=============
---------------------
General Configuration
---------------------
.. toctree::
:maxdepth: 1
brand_config
cert_config
host_config
system_config
time_sync_config
------------------------
Kubernetes Configuration
------------------------
.. toctree::
:maxdepth: 1
k8s_persistent_vol
-----------------------
OpenStack Configuration
-----------------------
.. toctree::
:maxdepth: 1
openstack_ironic_config
openstack_swift_config

View File

@ -0,0 +1,16 @@
===============================
Persistent Volume Configuration
===============================
This is a stub page for the topic: Configuring Persistent Volume Support. You
can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes Persistent Volume Support Config Guide <https://storyboard.openstack.org/#!/story/2006869>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==============================
OpenStack Ironic Configuration
==============================
This is a stub page for the topic: OpenStack Ironic Configuration and Management.
You can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add OpenStack Ironic Configuration and Management Guide <https://storyboard.openstack.org/#!/story/2006871>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=============================
OpenStack Swift Configuration
=============================
This is a stub page for the topic: OpenStack Swift Configuration. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add OpenStack Swift Configuration and Management Guide <https://storyboard.openstack.org/#!/story/2006870>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,17 @@
=====================
System Configuration
=====================
This is a stub page for the topic: System Configuration. You can help StarlingX
by expanding the content.
See the story for additional information about what is needed:
`Add System Configuration Guide <https://storyboard.openstack.org/#!/story/2006862>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==================================
Time Synchronization Configuration
==================================
This is a stub page for the topic: Time Synchronization Configuration. You can
help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Time Synchronization Configuration Guide <https://storyboard.openstack.org/#!/story/2006867>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -1,6 +1,6 @@
==================================
Installation and Deployment Guides
==================================
===================
Installation Guides
===================
Installation and deployment guides for StarlingX are release-specific.
Each guide provides instruction on a specific StarlingX configuration

View File

@ -19,7 +19,10 @@ The documentation is organized into the following sections:
introduction/index
deploy_install_guides/index
configuration/index
operations/index
api-ref/index
cli_ref/index
contributor/index
releasenotes/index
developer_resources/index

View File

@ -0,0 +1,16 @@
======================
Application Management
======================
This is a stub page for the topic: Application Management. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Application Management Guide <https://storyboard.openstack.org/#!/story/2006878>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==============================
Backup/Restore with Containers
==============================
This is a stub page for the topic: Backup/Restore with Containers. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Backup/Restore with Containers Guide <https://storyboard.openstack.org/#!/story/2006889>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==============================
Controller Services Management
==============================
This is a stub page for the topic: Controller Services Management. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Controller Services Management Guide <https://storyboard.openstack.org/#!/story/2006873>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===========
CPU Manager
===========
This is a stub page for the topic: CPU Manager. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add CPU Manager Guide <https://storyboard.openstack.org/#!/story/2006861>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===========================
Dedicate CPUs to Containers
===========================
This is a stub page for the topic: Dedicate CPUs to Containers. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes Dedicate CPUs to Container Guide <https://storyboard.openstack.org/#!/story/2006883>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
============================
Distributed Cloud Management
============================
This is a stub page for the topic: Distributed Cloud Management. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Distributed Cloud Management Guide <https://storyboard.openstack.org/#!/story/2006879>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
================
Fault Management
================
This is a stub page for the topic: Fault Management. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add Fault Management Guide <https://storyboard.openstack.org/#!/story/2006874>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===============
Host Management
===============
This is a stub page for the topic: Host Management. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add Host Management Guide <https://storyboard.openstack.org/#!/story/2006872>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,46 @@
================
Operation Guides
================
-----------------
General Operation
-----------------
.. toctree::
:maxdepth: 1
app_management
backup_restore_container
controller_service_manage
cpu_manager
dedicate_cpu_container
dist_cloud_management
fault_management
host_management
lldp_monitor
patching
storage_util_display
upgrade
--------------------
Kubernetes Operation
--------------------
.. toctree::
:maxdepth: 1
k8s_cluster
k8s_docker_reg_management
k8s_persistent_vol_claims
k8s_sriov_config
-------------------
OpenStack Operation
-------------------
.. toctree::
:maxdepth: 1
openstack_time_sensitive_networking
openstack_vm_pci_config
openstack_vm_sriov_config

View File

@ -0,0 +1,16 @@
========================
Kubernetes Cluster Guide
========================
This is a stub page for the topic: Kubernetes Cluster Guide. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes Cluster Guide <https://storyboard.openstack.org/#!/story/2006880>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=============================================
Kubernetes Docker Registry Management (Local)
=============================================
This is a stub page for the topic: Kubernetes Docker Registry Management (Local). You
can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes Docker Registry Management (Local) Guide <https://storyboard.openstack.org/#!/story/2006881>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=================================================
Kubernetes Persistent Volume Claims in Containers
=================================================
This is a stub page for the topic: Kubernetes Persistent Volume Claims in
Containers. You can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes Persistent Volume Claims in Containers Guide <https://storyboard.openstack.org/#!/story/2006882>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
========================================
Kubernetes SRIOV Container Configuration
========================================
This is a stub page for the topic: Kubernetes SRIOV Container Configuration. You
can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Kubernetes SRIOV Container Configuration Guide <https://storyboard.openstack.org/#!/story/2006884>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===========================
LLDP Monitoring and Display
===========================
This is a stub page for the topic: LLDP Monitoring and Display. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add LLDP Monitoring and Display Guide <https://storyboard.openstack.org/#!/story/2006876>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===================================
OpenStack Time Sensitive Networking
===================================
This is a stub page for the topic: OpenStack Time Sensitive Networking. You can
help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Time Sensitive Networking Guide (OpenStack) <https://storyboard.openstack.org/#!/story/2006885>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=============================================
OpenStack VM Generic PCI Device Configuration
=============================================
This is a stub page for the topic: OpenStack VM Generic PCI Device Configuration.
You can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add VM Generic PCI Device Configuration Guide <https://storyboard.openstack.org/#!/story/2006887>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
==========================================
OpenStack VM SRIOV Interface Configuration
==========================================
This is a stub page for the topic: OpenStack VM SRIOV Interface Configuration.
You can help StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add VM SRIOV Interface Configuration Guide (OpenStack) <https://storyboard.openstack.org/#!/story/2006886>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,15 @@
==================
StarlingX Patching
==================
This is a stub page for the topic: StarlingX Patching. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed: [link]
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
===========================
Storage Utilization Display
===========================
This is a stub page for the topic: Storage Utilization Display. You can help
StarlingX by expanding the content.
See the story for additional information about what is needed:
`Add Storage Utilization Display Guide <https://storyboard.openstack.org/#!/story/2006875>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1

View File

@ -0,0 +1,16 @@
=================
Upgrade StarlingX
=================
This is a stub page for the topic: Upgrade StarlingX. You can help StarlingX by
expanding the content.
See the story for additional information about what is needed:
`Add Upgrade Guide <https://storyboard.openstack.org/#!/story/2006877>`_
For information about contributing to the StarlingX documentation, see the
:doc:`/contributor/doc_contribute_guide`.
.. contents::
:local:
:depth: 1