docs/doc/source/index.rst
Scott Rifenbark 03b01e5f12 Added deployment_install AIO-SX combo manual
First draft of the combined deployment and installation
instructions for the AIO-SX StarlingX configuration.

Change-Id: Ib5bb6753aa1ed384c87e44b3c4d88945f2ed187a
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-20 07:04:17 -05:00

64 lines
1.7 KiB
ReStructuredText
Executable File

=======================
StarlingX Documentation
=======================
Welcome to the StarlingX documentation. This is the documentation for release
stx.2018.10. Additional information about this release is available in the
:ref:`release-notes`.
For more information about the project, consult the
`Project Specifications <specs/index.html>`__.
--------
Sections
--------
.. toctree::
:maxdepth: 1
introduction/index
deployment_guides/index
installation_guide/index
operation_guides/index
contributor/index
releasenotes/index
developer_resources/index
deploy_install_guides/index
--------
Projects
--------
StarlingX contains a number of sub-projects that include additional
Edge Cloud support services and clients:
* `Bare Metal <stx-metal/index.html>`__
* `Clients <stx-clients/index.html>`__
* `Config <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Distributed Cloud Client <stx-distcloud-client/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `Horizon Plugin (GUI) <stx-gui/index.html>`__
* `Integration <stx-integ/index.html>`__
* `NFV <stx-nfv/index.html>`__
* `Software Updates <stx-update/index.html>`__
* `Upstream <stx-upstream/index.html>`__
There are several supporting projects and repositories:
* `Tools <stx-tools/index.html>`__
----------
Contribute
----------
StarlingX utilizes tooling and CI/CD environments from the OpenStack
Foundation. The source is hosted on `OpenStack's Gerrit server`_.
.. _`OpenStack's Gerrit server`: https://git.starlingx.io
Additional information regarding contributing to the project can be
found in the :ref:`StarlingX contributor guides <contribute>`.