diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index cd6f37a4b..3e1c430e1 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -2,10 +2,20 @@ stx-docs API Reference ====================== -StarlingX Documentation +StarlingX Project API References + +* `Bare Metal `__ +* `Configuration `__ +* `Distributed Cloud `__ +* `Fault Management `__ +* `High Availability `__ +* `NFV `__ +* `Software Updates `__ + +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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 96f0d98c2..a6f6770f8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 `__ +* `Clients `__ +* `Config `__ +* `Distributed Cloud `__ +* `Distributed Cloud Client `__ +* `Fault Management `__ +* `High Availability `__ +* `Horizon Plugin (GUI) `__ +* `Integration `__ +* `NFV `__ +* `Software Updates `__ +* `Upstream `__ + +There are also a number of supporting projects and repositories: + +* `Tools `__ + Release Notes -------------- +============= + +Each StarlingX sub-project publishes its own Release Notes .. toctree:: :maxdepth: 1 - Release Notes + releasenotes/index + +API Reference +============= + +StarlingX sub-projects with REST APIs publish reference docs + + `API Reference `__ Specs ------ +===== -.. toctree:: - :maxdepth: 1 - - Specs + `Specs `__ API Reference ------------- diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst new file mode 100644 index 000000000..a225033d8 --- /dev/null +++ b/doc/source/releasenotes/index.rst @@ -0,0 +1,19 @@ +======================= +StarlingX Release Notes +======================= + +Project-specific Release Notes: + +* `Bare Metal `__ +* `Clients `__ +* `Configuration `__ +* `Distributed Cloud `__ +* `Distributed Cloud Client `__ +* `Fault Management `__ +* `High Availability `__ +* `Horizon Plugin (GUI) `__ +* `Integration `__ +* `NFV `__ +* `Software Updates `__ +* `Tools `__ +* `Upstream `__ diff --git a/tox.ini b/tox.ini index 3d0fbe205..8cdc99e74 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = linters +envlist = docs,linters minversion = 2.3 skipsdist = True