67 lines
1.8 KiB
ReStructuredText
67 lines
1.8 KiB
ReStructuredText
=======================
|
|
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`.
|
|
|
|
.. Add the additional version info here e.g.
|
|
The following documentation versions are available:
|
|
StarlingX stx.2019.09 | StarlingX stx.2019.04
|
|
|
|
For more information about the project, consult the
|
|
`Project Specifications <specs/index.html>`__.
|
|
|
|
--------
|
|
Sections
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
installation_guide/index
|
|
developer_guide/index
|
|
Project Specifications <https://docs.starlingx.io/specs/>
|
|
api-ref/index
|
|
releasenotes/index
|
|
contributor/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>`__
|
|
* `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>`.
|
|
|