TOC reorg
Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
parent
1521b4c4a9
commit
ec42ebdda0
@ -3,9 +3,9 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
===================
|
===========
|
||||||
Administrator Tasks
|
Admin Tasks
|
||||||
===================
|
===========
|
||||||
|
|
||||||
--------------------
|
--------------------
|
||||||
StarlingX Kubernetes
|
StarlingX Kubernetes
|
||||||
|
@ -17,15 +17,15 @@ For more information about the StarlingX project, refer to the
|
|||||||
|
|
||||||
.. Note::
|
.. Note::
|
||||||
|
|
||||||
Community contributions to the documentation are welcome! If you see an empty
|
Community contributions to the documentation are welcome! If you see an
|
||||||
topic and want to contribute, refer to the linked story in the topic for
|
empty topic and want to contribute, refer to the linked story in the topic
|
||||||
details.
|
for details.
|
||||||
|
|
||||||
See our :doc:`Contributor guide </contributor/index>` for more information.
|
See our :doc:`Contributor guide </contributor/index>` for more information.
|
||||||
|
|
||||||
-----------
|
------------
|
||||||
Get started
|
Introduction
|
||||||
-----------
|
------------
|
||||||
|
|
||||||
To get started fast with StarlingX, try the
|
To get started fast with StarlingX, try the
|
||||||
:doc:`Virtual All-in-one Simplex installation
|
:doc:`Virtual All-in-one Simplex installation
|
||||||
@ -39,24 +39,24 @@ Learn more about StarlingX:
|
|||||||
|
|
||||||
introduction/index
|
introduction/index
|
||||||
|
|
||||||
|
-------------------------
|
||||||
|
Deployment configurations
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
deploy/index
|
||||||
|
|
||||||
--------
|
--------
|
||||||
Planning
|
Planning
|
||||||
--------
|
--------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
planning/index
|
planning/index
|
||||||
|
|
||||||
-----------------
|
|
||||||
Deployment guides
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
deploy/index
|
|
||||||
|
|
||||||
-------------------
|
-------------------
|
||||||
Installation guides
|
Installation guides
|
||||||
-------------------
|
-------------------
|
||||||
@ -66,33 +66,6 @@ Installation guides
|
|||||||
|
|
||||||
deploy_install_guides/index
|
deploy_install_guides/index
|
||||||
|
|
||||||
-------------
|
|
||||||
Configuration
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
configuration/index
|
|
||||||
|
|
||||||
------------------------------------------------
|
|
||||||
Data Network Configuration and Management Guides
|
|
||||||
------------------------------------------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
datanet/index
|
|
||||||
|
|
||||||
---------------
|
|
||||||
Node Management
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
node_management/index
|
|
||||||
|
|
||||||
--------
|
--------
|
||||||
Security
|
Security
|
||||||
--------
|
--------
|
||||||
@ -102,8 +75,9 @@ Security
|
|||||||
|
|
||||||
security/index
|
security/index
|
||||||
|
|
||||||
|
|
||||||
--------------------
|
--------------------
|
||||||
System Configuration
|
System configuration
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
@ -111,42 +85,25 @@ System Configuration
|
|||||||
|
|
||||||
system_configuration/index
|
system_configuration/index
|
||||||
|
|
||||||
----------------
|
|
||||||
Fault Management
|
-------------
|
||||||
----------------
|
Data networks
|
||||||
|
-------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
fault-mgmt/index
|
datanet/index
|
||||||
|
|
||||||
-----------
|
|
||||||
Admin Tasks
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
admintasks/index
|
|
||||||
|
|
||||||
----------
|
|
||||||
User Tasks
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
usertasks/index
|
|
||||||
|
|
||||||
---------------
|
---------------
|
||||||
VNF Integration
|
Node management
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
vnf_integration/index
|
node_management/index
|
||||||
|
|
||||||
-------
|
-------
|
||||||
Storage
|
Storage
|
||||||
-------
|
-------
|
||||||
@ -156,14 +113,16 @@ Storage
|
|||||||
|
|
||||||
storage/index
|
storage/index
|
||||||
|
|
||||||
|
|
||||||
----------------
|
----------------
|
||||||
Operation guides
|
Fault management
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
operations/index
|
fault-mgmt/index
|
||||||
|
|
||||||
|
|
||||||
------------------
|
------------------
|
||||||
Backup and restore
|
Backup and restore
|
||||||
@ -174,24 +133,6 @@ Backup and restore
|
|||||||
|
|
||||||
backup/index
|
backup/index
|
||||||
|
|
||||||
---------------------
|
|
||||||
Container integration
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
container_integration/kubernetes/index
|
|
||||||
|
|
||||||
-----------------
|
|
||||||
Distributed Cloud
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
dist_cloud/index
|
|
||||||
|
|
||||||
-------
|
-------
|
||||||
Updates
|
Updates
|
||||||
@ -202,6 +143,38 @@ Updates
|
|||||||
|
|
||||||
updates/index
|
updates/index
|
||||||
|
|
||||||
|
|
||||||
|
-----------
|
||||||
|
Admin tasks
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
admintasks/index
|
||||||
|
|
||||||
|
|
||||||
|
----------
|
||||||
|
User tasks
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
usertasks/index
|
||||||
|
|
||||||
|
|
||||||
|
-----------------
|
||||||
|
Guest integration
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
vnf_integration/index
|
||||||
|
container_integration/kubernetes/index
|
||||||
|
|
||||||
|
|
||||||
---------
|
---------
|
||||||
Reference
|
Reference
|
||||||
---------
|
---------
|
||||||
@ -212,6 +185,42 @@ Reference
|
|||||||
api-ref/index
|
api-ref/index
|
||||||
cli_ref/index
|
cli_ref/index
|
||||||
|
|
||||||
|
-----------------
|
||||||
|
Distributed Cloud
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
dist_cloud/index
|
||||||
|
|
||||||
|
-----------------
|
||||||
|
Deprecated guides
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
The guides listed here have been replaced by new guides that provide more
|
||||||
|
details.
|
||||||
|
|
||||||
|
*************
|
||||||
|
Configuration
|
||||||
|
*************
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
configuration/index
|
||||||
|
|
||||||
|
|
||||||
|
****************
|
||||||
|
Operation guides
|
||||||
|
****************
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
operations/index
|
||||||
|
|
||||||
|
|
||||||
-------------------
|
-------------------
|
||||||
General information
|
General information
|
||||||
-------------------
|
-------------------
|
||||||
@ -222,6 +231,7 @@ General information
|
|||||||
contributor/index
|
contributor/index
|
||||||
releasenotes/index
|
releasenotes/index
|
||||||
developer_resources/index
|
developer_resources/index
|
||||||
|
Project Specifications <https://docs.starlingx.io/specs/>
|
||||||
|
|
||||||
----------
|
----------
|
||||||
Governance
|
Governance
|
||||||
@ -237,3 +247,5 @@ governance.
|
|||||||
.. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation
|
.. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation
|
||||||
.. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/
|
.. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/
|
||||||
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/
|
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
======================
|
============
|
||||||
StarlingX Introduction
|
Introduction
|
||||||
======================
|
============
|
||||||
|
|
||||||
StarlingX is a fully integrated edge cloud software stack that provides
|
StarlingX is a fully integrated edge cloud software stack that provides
|
||||||
everything needed to deploy an edge cloud on one, two, or up to 100 servers.
|
everything needed to deploy an edge cloud on one, two, or up to 100 servers.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user