1c68e4ef08
Replace the R5 install guides folder in latest branch. Review 793093 (which moved the R5 install guides) broke the downstream doc publishing process. Made some path changes in R5 Release Notes. Change-Id: Ia574c3da47e31036b2a2cbea06d43f0d1493945a Signed-off-by: MCamp859 <maryx.camp@intel.com>
78 lines
2.4 KiB
ReStructuredText
Executable File
78 lines
2.4 KiB
ReStructuredText
Executable File
===================
|
|
Installation Guides
|
|
===================
|
|
|
|
Installation and deployment guides for StarlingX are release-specific.
|
|
Each guide provides instruction on a specific StarlingX configuration
|
|
(e.g. All-in-one Simplex).
|
|
|
|
-------------------------
|
|
Upcoming release (latest)
|
|
-------------------------
|
|
|
|
StarlingX R6.0 is under development.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
r6_release/index
|
|
|
|
|
|
-----------------
|
|
Supported release
|
|
-----------------
|
|
|
|
StarlingX R5.0 is the most recent supported release of StarlingX.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
r5_release/index
|
|
|
|
|
|
-----------------
|
|
Archived releases
|
|
-----------------
|
|
|
|
To view the archived installation guides, see `Installation guides for R5.0 and
|
|
older releases <https://docs.starlingx.io/r/stx.5.0/deploy_install_guides/index.html>`_.
|
|
|
|
|
|
|
|
|
|
.. Add common files to toctree
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
|
|
bootable_usb
|
|
nvme_config
|
|
|
|
.. Docs note: Starting with R5 (May 2021), team agreed that the latest/working
|
|
branch will include the current & supported install guides only. The archived
|
|
releases will only be available in a release-specific branch. The
|
|
instructions below are modified to reflect this change.
|
|
|
|
.. Making a new release
|
|
.. 1. Copy the previous 'upcoming' release to the 'supported' release section.
|
|
Copy the old 'supported' folder to the release-specific branch.
|
|
Copy the toctree link into the Supported section of install landing page.
|
|
Update intro text for the Supported release section to use the
|
|
latest version.
|
|
.. 2. Add new 'upcoming' release, aka 'Latest' on the version button.
|
|
If new upcoming release docs aren't ready, remove toctree from Upcoming
|
|
section and just leave intro text. Update text for the upcoming
|
|
release version. Once the new upcoming docs are ready, add them in the
|
|
toctree here.
|
|
|
|
.. Adding new release docs
|
|
.. 1. Make sure the most recent release versioned docs are complete for that
|
|
release.
|
|
.. 2. Make a copy of the most recent release folder e.g. 'r6_release.' Rename
|
|
the folder for the new release e.g. 'r7_release'.
|
|
.. 3. Search and replace all references to previous release number with the new
|
|
release number. For example replace all 'R6.0' with 'R7.0.' Also search
|
|
and replace any links that may have a specific release number in the path.
|
|
.. 4. Link new version on this page (the index page).
|