starlingx/docs
Code Issues Proposed changes

Unique index names (intro)

Browse Source 
Make Introduction index name unique.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ic0cf24fa21be3f7b0f02d786ecc2f554624cb18b
This commit is contained in:
Ron Stone 2022-01-20 11:24:02 -05:00
parent 0b803bfad1
commit 7c3938878d
3 changed files with 69 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/contributor/doc_contribute_guide.rst
View File

@ -78,7 +78,7 @@ Docs organization
Documentation for StarlingX is organized into the following sections:
:doc:`/introduction/index`
:doc:`/introduction/index-intro-27197f27ad41`
Overview of the StarlingX project.
:doc:`/deploy_install_guides/index`

2
doc/source/index.rst
View File

@ -37,7 +37,7 @@ Learn more about StarlingX:
.. toctree::
:maxdepth: 2
introduction/index
introduction/index-intro-27197f27ad41
-------------------------
Deployment configurations

132
doc/source/introduction/index.rst → doc/source/introduction/index-intro-27197f27ad41.rst
View File

@ -1,66 +1,68 @@
============
Introduction
============
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.
Key features of StarlingX include:
* Provided as a single, easy to install package that includes an operating system,
storage and networking components, and all the cloud infrastructure needed to
run edge workloads.
* Optimized software that meets edge application requirements.
* Designed with pre-defined configurations to meet a variety of edge cloud deployment
needs.
* Tested and released as a complete stack, ensuring compatibility among open
source components.
* Included fault management and service management capabilities, which provide
high availability for user applications.
* Optimized by the community for security, ultra-low latency, extremely high
service uptime, and streamlined operation.
Download the StarlingX ISO image from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_.
Learn more about StarlingX:
.. toctree::
:maxdepth: 1
functional_overview
deploy_config_overview
deploy_options
terms
consuming
StarlingX Project Overview (PDF) <https://www.starlingx.io/collateral/StarlingX_Onboarding_Deck_for_Web.pdf>
.. _stx_projects:
--------
Projects
--------
StarlingX contains multiple sub-projects that include additional edge cloud
support services and clients. API documentation and release notes for each
project are found on the specific project page:
* `Bare Metal </metal/index.html>`__
* `Clients </clients/index.html>`__
* `Config </config/index.html>`__
* `Distributed Cloud </distcloud/index.html>`__
* `Distributed Cloud Client </distcloud-client/index.html>`__
* `Fault Management </fault/index.html>`__
* `High Availability </ha/index.html>`__
* `Horizon Plugin (GUI) </gui/index.html>`__
* `Integration </integ/index.html>`__
* `NFV </nfv/index.html>`__
* `Software Updates </update/index.html>`__
* `Upstream </upstream/index.html>`__
Supporting projects and repositories:
* `Tools </tools/index.html>`__
For additional information about project teams, refer to the
.. _index-intro-27197f27ad41:
============
Introduction
============
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.
Key features of StarlingX include:
* Provided as a single, easy to install package that includes an operating system,
storage and networking components, and all the cloud infrastructure needed to
run edge workloads.
* Optimized software that meets edge application requirements.
* Designed with pre-defined configurations to meet a variety of edge cloud deployment
needs.
* Tested and released as a complete stack, ensuring compatibility among open
source components.
* Included fault management and service management capabilities, which provide
high availability for user applications.
* Optimized by the community for security, ultra-low latency, extremely high
service uptime, and streamlined operation.
Download the StarlingX ISO image from the
`CENGN StarlingX mirror <http://mirror.starlingx.cengn.ca/mirror/starlingx/>`_.
Learn more about StarlingX:
.. toctree::
:maxdepth: 1
functional_overview
deploy_config_overview
deploy_options
terms
consuming
StarlingX Project Overview (PDF) <https://www.starlingx.io/collateral/StarlingX_Onboarding_Deck_for_Web.pdf>
.. _stx_projects:
--------
Projects
--------
StarlingX contains multiple sub-projects that include additional edge cloud
support services and clients. API documentation and release notes for each
project are found on the specific project page:
* `Bare Metal </metal/index.html>`__
* `Clients </clients/index.html>`__
* `Config </config/index.html>`__
* `Distributed Cloud </distcloud/index.html>`__
* `Distributed Cloud Client </distcloud-client/index.html>`__
* `Fault Management </fault/index.html>`__
* `High Availability </ha/index.html>`__
* `Horizon Plugin (GUI) </gui/index.html>`__
* `Integration </integ/index.html>`__
* `NFV </nfv/index.html>`__
* `Software Updates </update/index.html>`__
* `Upstream </upstream/index.html>`__
Supporting projects and repositories:
* `Tools </tools/index.html>`__
For additional information about project teams, refer to the
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.