docs/doc/source/index.rst

60 lines
1.4 KiB
ReStructuredText

=======================
StarlingX Documentation
=======================
Abstract
========
This is the general documentation for the StarlingX project.
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 also a number of supporting projects and repositories:
* `Tools <stx-tools/index.html>`__
Specs
=====
`Project Specifications <specs/index.html>`__
Contents
--------
.. toctree::
:maxdepth: 1
:caption: Contents:
installation_guide/index
developer_guide/index
api-ref/index
releasenotes/index
contributor/index
Contributing
============
StarlingX utilized 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