diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index cd6f37a4b..4240ff0d9 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/api-ref/index.rst b/doc/source/api-ref/index.rst new file mode 100644 index 000000000..87c060a40 --- /dev/null +++ b/doc/source/api-ref/index.rst @@ -0,0 +1,22 @@ +====================== +stx-docs API Reference +====================== + +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: + +* `Block Storage v2 `__ +* `Compute v2 `__ +* `Image v2 `__ +* `Network v2 `__ + +:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index 4e872df3d..6c5fe5699 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,19 +2,38 @@ StarlingX Documentation ======================= +Abstract +======== -Welcome to the StarlingX project documentation for [version]. +This is the general documentation for the StarlingX project. -View the VERSION Release Notes -for release specific details. +Projects +======== -The following versions of the documentation are available: +StarlingX contains a number of sub-projects that include additional +Edge Cloud support services and clients. -StarlingX v1 | StarlingX v2 | StarlingX v3 +* `Bare Metal `__ +* `Clients `__ +* `Config `__ +* `Distributed Cloud `__ +* `Distributed Cloud Client `__ +* `Fault Management `__ +* `High Availability `__ +* `Horizon Plugin (GUI) `__ +* `Integration `__ +* `NFV `__ +* `Software Updates `__ +* `Upstream `__ -StarlingX is provided under ... ToDo. +There are also a number of supporting projects and repositories: -Source code is maintained at the StarlingX GitHub repo. +* `Tools `__ + +Specs +===== + + `Project Specifications `__ Contents -------- @@ -25,10 +44,9 @@ Contents installation_guide/index developer_guide/index - API Reference - Release Notes + api-ref/index + releasenotes/index contributor/index - Project Specifications Contributing 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