docs/doc/source/index.rst

42 lines
990 B
ReStructuredText

=======================
StarlingX Documentation
=======================
Welcome to the StarlingX project documentation for [version].
View the VERSION Release Notes <https://docs.starlingx.io/releasenotes>
for release specific details.
The following versions of the documentation are available:
StarlingX v1 | StarlingX v2 | StarlingX v3
StarlingX is provided under ... ToDo.
Source code is maintained at the StarlingX GitHub repo.
Contents
--------
.. toctree::
:maxdepth: 1
:caption: Contents:
installation_guide/index
developer_guide/index
API Reference <https://docs.starlingx.io/api-ref/stx-docs>
Release Notes <https://docs.starlingx.io/releasenotes>
contributor/index
Project Specifications <https://docs.starlingx.io/specs>
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