diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 4d52b1088..78884b441 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -7,6 +7,11 @@ Contribute The following guides provide detailed instructions on the contribution workflow and conventions to be considered when contributing to the StarlingX documentation. +StarlingX utilizes tooling and CI/CD environments from the OpenStack +Foundation. The source is hosted on `OpenDev's Git server`_. + +.. _`OpenDev's Git server`: https://opendev.org/starlingx + --------------------------- Contribute to documentation --------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 68bec51b5..5344a1731 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,68 +2,83 @@ Welcome to the StarlingX Documentation ====================================== -The latest release of StarlingX is StarlingX R2.0. Additional information about -this release is available in the :ref:`release-notes`. +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. + +**The latest release of StarlingX is StarlingX R2.0.** Additional information +about this release is available in the :ref:`release-notes`. For more information about the StarlingX project, refer to the -`Project Specifications `__. +`StarlingX wiki `__. + +.. Note:: + + Community contributions to the documentation are welcome! If you see an empty + topic and want to contribute, refer to the linked story in the topic for details. + + Additional information in the :doc:`Contributor guide `. + +----------- +Get started +----------- + +To get started fast with StarlingX, try the Virtual All-in-one Simplex installation for the :ref:`latest release `, which requires a minimum of hardware and configuration. + +Learn more about StarlingX: + +.. toctree:: + :maxdepth: 2 + + introduction/index + +------------------- +Installation guides +------------------- + +.. toctree:: + :maxdepth: 2 + + deploy_install_guides/index ------------- -Documentation +Configuration ------------- -The documentation is organized into the following sections: +.. toctree:: + :maxdepth: 2 + + configuration/index + +---------------- +Operation guides +---------------- + +.. toctree:: + :maxdepth: 2 + + operations/index + +--------- +Reference +--------- + +.. toctree:: + :maxdepth: 2 + + api-ref/index + cli_ref/index + +------------------- +General information +------------------- .. toctree:: :maxdepth: 1 - introduction/index - deploy_install_guides/index - configuration/index - operations/index - api-ref/index - cli_ref/index contributor/index releasenotes/index developer_resources/index --------- -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 `__ -* `Clients `__ -* `Config `__ -* `Distributed Cloud `__ -* `Distributed Cloud Client `__ -* `Fault Management `__ -* `High Availability `__ -* `Horizon Plugin (GUI) `__ -* `Integration `__ -* `NFV `__ -* `Software Updates `__ -* `Upstream `__ - -Supporting projects and repositories: - -* `Tools `__ - ----------- -Contribute ----------- - -StarlingX utilizes tooling and CI/CD environments from the OpenStack -Foundation. The source is hosted on `OpenDev's Git server`_. - -.. _`OpenDev's Git server`: https://opendev.org/starlingx - -Additional information regarding contributing to the project can be -found in the :ref:`StarlingX contributor guides `. - ---------- Governance ---------- @@ -77,4 +92,9 @@ governance. .. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation .. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/ -.. _`StarlingX Governance`: https://docs.starlingx.io/governance/ \ No newline at end of file +.. _`StarlingX Governance`: https://docs.starlingx.io/governance/ + + + + + diff --git a/doc/source/introduction/index.rst b/doc/source/introduction/index.rst index b97b2f1db..995e4bdb9 100644 --- a/doc/source/introduction/index.rst +++ b/doc/source/introduction/index.rst @@ -28,3 +28,30 @@ Learn more about StarlingX: terms deploy_options consuming + +.. _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 `__ +* `Clients `__ +* `Config `__ +* `Distributed Cloud `__ +* `Distributed Cloud Client `__ +* `Fault Management `__ +* `High Availability `__ +* `Horizon Plugin (GUI) `__ +* `Integration `__ +* `NFV `__ +* `Software Updates `__ +* `Upstream `__ + +Supporting projects and repositories: + +* `Tools `__ \ No newline at end of file