3e98ec2859
Add link to CENGN mirror on home page, introduction, and consuming doc. This review supercedes review #617965 Change-Id: I1211e26e523ce75c954c8c7f5835c2228fc94baf Signed-off-by: Kristal Dale <kristal.dale@intel.com>
105 lines
2.3 KiB
ReStructuredText
Executable File
105 lines
2.3 KiB
ReStructuredText
Executable File
======================================
|
|
Welcome to the StarlingX Documentation
|
|
======================================
|
|
|
|
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 R3.0.**
|
|
|
|
* See the :ref:`release-notes`.
|
|
* `Download the R3.0 StarlingX ISO <http://mirror.starlingx.cengn.ca/mirror/starlingx/release/3.0.0/>`_.
|
|
|
|
For more information about the StarlingX project, refer to the
|
|
`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
|
|
:doc:`Virtual All-in-one Simplex installation </deploy_install_guides/r3_release/virtual/aio_simplex>`,
|
|
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
|
|
|
|
-------------
|
|
Configuration
|
|
-------------
|
|
|
|
.. 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
|
|
|
|
contributor/index
|
|
releasenotes/index
|
|
developer_resources/index
|
|
|
|
----------
|
|
Governance
|
|
----------
|
|
|
|
StarlingX is a top-level OpenStack Foundation pilot project that is governed by
|
|
two separate bodies: The `OpenStack Foundation Board of Directors`_ and the
|
|
`StarlingX Technical Steering Committee`_.
|
|
|
|
See `StarlingX Governance`_ for additional information about StarlingX project
|
|
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/
|
|
|
|
|
|
|
|
|
|
|