Add project links and pages for API Ref and Release Notes
The project-specific docs are published independently so we need to maintain the links into those subtrees (/stx-*), also for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*). Also add docs env to the default list in tox.ini. Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
This commit is contained in:
parent
f253a48c45
commit
8ad8ff101d
|
@ -2,10 +2,20 @@
|
|||
stx-docs API Reference
|
||||
======================
|
||||
|
||||
StarlingX Documentation
|
||||
StarlingX Project API References
|
||||
|
||||
* `Bare Metal <stx-metal/index.html>`__
|
||||
* `Configuration <stx-config/index.html>`__
|
||||
* `Distributed Cloud <stx-distcloud/index.html>`__
|
||||
* `Fault Management <stx-fault/index.html>`__
|
||||
* `High Availability <stx-ha/index.html>`__
|
||||
* `NFV <stx-nfv/index.html>`__
|
||||
* `Software Updates <stx-update/index.html>`__
|
||||
|
||||
StarlingX also has API References for the modified OpenStack APIs
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
|
||||
api-ref-blockstorage-v2-cgcs-ext
|
||||
api-ref-compute-v2-cgcs-ext
|
||||
|
|
|
@ -3,12 +3,12 @@ StarlingX Documentation
|
|||
=======================
|
||||
|
||||
Abstract
|
||||
--------
|
||||
========
|
||||
|
||||
This is the general documentation for the StarlingX project.
|
||||
|
||||
Contents
|
||||
--------
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
@ -17,21 +17,50 @@ Contents
|
|||
getting_started.rst
|
||||
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>`__
|
||||
* `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>`__
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
=============
|
||||
|
||||
Each StarlingX sub-project publishes its own Release Notes
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Release Notes <https://docs.starlingx.io/releasenotes>
|
||||
releasenotes/index
|
||||
|
||||
API Reference
|
||||
=============
|
||||
|
||||
StarlingX sub-projects with REST APIs publish reference docs
|
||||
|
||||
`API Reference <api-ref/index.html>`__
|
||||
|
||||
Specs
|
||||
-----
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Specs <https://docs.starlingx.io/specs>
|
||||
`Specs <specs/index.html>`__
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
|
|
@ -0,0 +1,19 @@
|
|||
=======================
|
||||
StarlingX Release Notes
|
||||
=======================
|
||||
|
||||
Project-specific Release Notes:
|
||||
|
||||
* `Bare Metal <stx-metal/index.html>`__
|
||||
* `Clients <stx-clients/index.html>`__
|
||||
* `Configuration <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>`__
|
||||
* `Tools <stx-tools/index.html>`__
|
||||
* `Upstream <stx-upstream/index.html>`__
|
Loading…
Reference in New Issue