3b0b2b0199
Changes included updating the StarlingX docs landing page to conform to a new list of available documents as follows: * StarlingX Introduction * Deployment Guides * Installation Guides * Developer resources * Operation Guides * Project Specifications * REST API Reference * Release Notes * Contribute So-called "dead-end" links have an explanation of content coming. Any destination associated with an existing story ID have the link to the story for reference. The existence of a "current" and "latest" Developer Guides resulted in the top-level list of doc resources including both the "Developer Guides" and "Developer Resources" bullets. Ideally, the Developer Guides would be included as part of the "Developer Resources" area. For "latest" they are. However, for "current" I left them alone since the 2018.10 release is out there. This organization can settle out as more releases launch. Finally, I did not focus on the writing aspect for this PR. That part can be cleaned up going forward. Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
63 lines
1.7 KiB
ReStructuredText
63 lines
1.7 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`.
|
|
|
|
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
|
|
|
|
--------
|
|
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>`.
|
|
|