starlingx/docs
Code Issues Proposed changes

Merge "Docs update for R3"

Browse Source
This commit is contained in:
Zuul 2019-12-16 20:34:08 +00:00 committed by Gerrit Code Review
commit f54d6f00c6
4 changed files with 21 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/deploy_install_guides/index.rst
View File

@ -12,24 +12,20 @@ Each guide provides instruction on a specific StarlingX configuration
Latest release (stable)
-----------------------
StarlingX R2.0 is the latest officially released version of StarlingX.
.. toctree::
:maxdepth: 1
r2_release/index
---------------------
Upcoming R3.0 release
---------------------
StarlingX R3.0 is the forthcoming version of StarlingX under development.
StarlingX R3.0 is the latest officially released version of StarlingX.
.. toctree::
:maxdepth: 1
r3_release/index
---------------------
Upcoming R4.0 release
---------------------
StarlingX R4.0 is the forthcoming version of StarlingX under development.
-----------------
Archived releases
-----------------
@ -37,6 +33,7 @@ Archived releases
.. toctree::
:maxdepth: 1
r2_release/index
r1_release/index

8
doc/source/deploy_install_guides/r2_release/index.rst
View File

@ -2,6 +2,14 @@
StarlingX R2.0 Installation
===========================
.. important::
Changes in the underlying StarlingX infrastructure have occurred
since the R2.0 release. Due to these changes, the R2.0 installation
instructions may not work as described.
Installation of the the :ref:`latest_release` is recommended.
StarlingX provides a pre-defined set of standard
:doc:`deployment configurations </introduction/deploy_options>`. Most deployment options may
be installed in a virtual environment or on bare metal.

8
doc/source/deploy_install_guides/r3_release/index.rst
View File

@ -2,14 +2,6 @@
StarlingX R3.0 Installation
===========================
.. Note::
StarlingX R3.0 is the upcoming release currently under development. Instructions
and examples may change with the final release of R3.0.
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.
StarlingX provides a pre-defined set of standard
:doc:`deployment configurations </introduction/deploy_options>`. Most deployment options may
be installed in a virtual environment or on bare metal.

8
doc/source/index.rst
View File

@ -5,7 +5,7 @@ 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 R2.0.** Additional information
**The latest release of StarlingX is StarlingX R3.0.** Additional information
about this release is available in the :ref:`release-notes`.
For more information about the StarlingX project, refer to the
@ -22,9 +22,9 @@ For more information about the StarlingX project, refer to the
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.
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: