Update landing page

- Add Get Started section to landing page
- Replace Contribute section with note welcoming contributions (with links)
- Split Documentation section into Installation Guides, Config, Operation Guides
  Reference, General info sections (Improve scanability of topics)
- Move note re using OpenStack CI/CD and repo link to Contribute page.
- Replace link to spec with link to wiki (more relevant to new users)
- Move projects section/list to StarlingX Introduction.

Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2019-12-06 15:44:38 -08:00
parent 87dc6ed862
commit 5be38d94c1
3 changed files with 101 additions and 49 deletions

View File

@ -7,6 +7,11 @@ Contribute
The following guides provide detailed instructions on the contribution workflow
and conventions to be considered when contributing to the StarlingX documentation.
StarlingX utilizes tooling and CI/CD environments from the OpenStack
Foundation. The source is hosted on `OpenDev's Git server`_.
.. _`OpenDev's Git server`: https://opendev.org/starlingx
---------------------------
Contribute to documentation
---------------------------

View File

@ -2,68 +2,83 @@
Welcome to the StarlingX Documentation
======================================
The latest release of StarlingX is StarlingX R2.0. Additional information about
this release is available in the :ref:`release-notes`.
StarlingX is a fully integrated edge cloud software stack that provides
everything needed to deploy an edge cloud on one, two, or up to 100 servers.
**The latest release of StarlingX is StarlingX R2.0.** Additional information
about this release is available in the :ref:`release-notes`.
For more information about the StarlingX project, refer to the
`Project Specifications <specs/index.html>`__.
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`__.
.. Note::
Community contributions to the documentation are welcome! If you see an empty
topic and want to contribute, refer to the linked story in the topic for details.
Additional information in the :doc:`Contributor guide </contributor/index>`.
-----------
Get started
-----------
To get started fast with StarlingX, try the Virtual All-in-one Simplex installation for the :ref:`latest release <latest_release>`, which requires a minimum of hardware and configuration.
Learn more about StarlingX:
.. toctree::
:maxdepth: 2
introduction/index
-------------------
Installation guides
-------------------
.. toctree::
:maxdepth: 2
deploy_install_guides/index
-------------
Documentation
Configuration
-------------
The documentation is organized into the following sections:
.. toctree::
:maxdepth: 2
configuration/index
----------------
Operation guides
----------------
.. toctree::
:maxdepth: 2
operations/index
---------
Reference
---------
.. toctree::
:maxdepth: 2
api-ref/index
cli_ref/index
-------------------
General information
-------------------
.. toctree::
:maxdepth: 1
introduction/index
deploy_install_guides/index
configuration/index
operations/index
api-ref/index
cli_ref/index
contributor/index
releasenotes/index
developer_resources/index
--------
Projects
--------
StarlingX contains multiple sub-projects that include additional edge cloud
support services and clients. API documentation and release notes for each
project are found on the specific project page:
* `Bare Metal <metal/index.html>`__
* `Clients <clients/index.html>`__
* `Config <config/index.html>`__
* `Distributed Cloud <distcloud/index.html>`__
* `Distributed Cloud Client <distcloud-client/index.html>`__
* `Fault Management <fault/index.html>`__
* `High Availability <ha/index.html>`__
* `Horizon Plugin (GUI) <gui/index.html>`__
* `Integration <integ/index.html>`__
* `NFV <nfv/index.html>`__
* `Software Updates <update/index.html>`__
* `Upstream <upstream/index.html>`__
Supporting projects and repositories:
* `Tools <tools/index.html>`__
----------
Contribute
----------
StarlingX utilizes tooling and CI/CD environments from the OpenStack
Foundation. The source is hosted on `OpenDev's Git server`_.
.. _`OpenDev's Git server`: https://opendev.org/starlingx
Additional information regarding contributing to the project can be
found in the :ref:`StarlingX contributor guides <contribute>`.
----------
Governance
----------
@ -77,4 +92,9 @@ governance.
.. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation
.. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/

View File

@ -28,3 +28,30 @@ Learn more about StarlingX:
terms
deploy_options
consuming
.. _stx_projects:
--------
Projects
--------
StarlingX contains multiple sub-projects that include additional edge cloud
support services and clients. API documentation and release notes for each
project are found on the specific project page:
* `Bare Metal <metal/index.html>`__
* `Clients <clients/index.html>`__
* `Config <config/index.html>`__
* `Distributed Cloud <distcloud/index.html>`__
* `Distributed Cloud Client <distcloud-client/index.html>`__
* `Fault Management <fault/index.html>`__
* `High Availability <ha/index.html>`__
* `Horizon Plugin (GUI) <gui/index.html>`__
* `Integration <integ/index.html>`__
* `NFV <nfv/index.html>`__
* `Software Updates <update/index.html>`__
* `Upstream <upstream/index.html>`__
Supporting projects and repositories:
* `Tools <tools/index.html>`__