Reorg of docs master TOC
* Amended to make punctuation consistent. I have re-organized the main TOC so that the new combined install/deploy manuals comes after the StarlingX introduction. I have hidden (for now) the older install and deploy manuals. Finally, I have updated the landing pages for the install/ deploy guides and the operation guides to an agreed upon format that separates out latest, upcoming, and archived releases. Change-Id: Ia18f0438152d6cb1fa7ae3e9712eb3df8f5a2862 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This commit is contained in:
parent
278eb6ab0e
commit
7795fe1342
@ -1,23 +1,70 @@
|
|||||||
==================================
|
==================================
|
||||||
Deployment and installation guides
|
Installation and Deployment Guides
|
||||||
==================================
|
==================================
|
||||||
|
|
||||||
Deployment and installation guides for StarlingX are release-specific.
|
|
||||||
Each guide provides instruction on a specific StarlingX configuration
|
|
||||||
(e.g. All-in-one Simplex).
|
|
||||||
|
|
||||||
The following list provides help on choosing the correct deployment guide:
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:hidden:
|
||||||
|
|
||||||
latest/aio_simplex/index
|
latest/aio_simplex/index
|
||||||
latest/aio_duplex/index
|
latest/aio_duplex/index
|
||||||
|
|
||||||
- Following are deployment and installation guides for past StarlingX
|
|
||||||
releases that have been archived:
|
|
||||||
|
|
||||||
* Currently, no archived deployment guides exist.
|
Installation and deployment guides for StarlingX are release-specific.
|
||||||
|
Each guide provides instruction on a specific StarlingX configuration
|
||||||
|
(e.g. All-in-one Simplex).
|
||||||
|
|
||||||
|
***********************
|
||||||
|
Latest official release
|
||||||
|
***********************
|
||||||
|
|
||||||
|
The latest official release is the most recent officially
|
||||||
|
released version of StarlingX.
|
||||||
|
|
||||||
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
Installation guide
|
||||||
|
^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
- `Installation stx.2018.10 <../../html/installation_guide/current/index.html>`__
|
||||||
|
|
||||||
|
^^^^^^^^^^^^^^^^^
|
||||||
|
Deployment guides
|
||||||
|
^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
- `All-in-one simplex stx.2018.10 <../../html/deployment_guides/current/simplex.html>`__
|
||||||
|
- `All-in-one duplex stx.2018.10 <../../html/deployment_guides/current/duplex.html>`__
|
||||||
|
- `Controller storage stx.2018.10 <../../html/deployment_guides/current/controller_storage.html>`__
|
||||||
|
- `Dedicated storage stx.2018.10 <../../html/deployment_guides/current/dedicated_storage.html>`__
|
||||||
|
|
||||||
|
****************
|
||||||
|
Upcoming release
|
||||||
|
****************
|
||||||
|
|
||||||
|
The upcoming release is the forthcoming version under development.
|
||||||
|
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
Deployment planning
|
||||||
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
- `Deployment planning <../../html/deployment_guides/latest/planning/index.html>`__
|
||||||
|
- `Deployment options <../../html/deployment_guides/latest/options/index.html>`__
|
||||||
|
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
Installation and deployment guides
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
- `All-in-one simplex R2.0 <../../html/deploy_install_guides/latest/aio_simplex/index.html>`__
|
||||||
|
- `All-in-one duplex R2.0 <../../html/deploy_install_guides/latest/aio_duplex/index.html>`__
|
||||||
|
- `Standard controller storage R2.0 <../../html/deploy_install_guides/latest/controller_storage/index.html>`__
|
||||||
|
- `Standard dedicated storage R2.0 <../../html/deploy_install_guides/latest/dedicated_storage/index.html>`__
|
||||||
|
- `Standard with Ironic <../../html/deployment_guides/latest/ironic/index.html>`__
|
||||||
|
- `Multi-region <../../html/deployment_guides/latest/multi_region/index.html>`__
|
||||||
|
- `Distributed cloud <../../html/deployment_guides/latest/dist_cloud/index.html>`__
|
||||||
|
|
||||||
|
*****************
|
||||||
|
Archived releases
|
||||||
|
*****************
|
||||||
|
|
||||||
|
Currently, there are no archived guides.
|
||||||
|
|
||||||
|
|
||||||
.. Steps you must take when a new release of the deployment and installation
|
.. Steps you must take when a new release of the deployment and installation
|
||||||
@ -77,3 +124,4 @@ The following list provides help on choosing the correct deployment guide:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -17,13 +17,18 @@ Sections
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
introduction/index
|
introduction/index
|
||||||
deployment_guides/index
|
deploy_install_guides/index
|
||||||
installation_guide/index
|
|
||||||
operation_guides/index
|
operation_guides/index
|
||||||
contributor/index
|
contributor/index
|
||||||
releasenotes/index
|
releasenotes/index
|
||||||
developer_resources/index
|
developer_resources/index
|
||||||
deploy_install_guides/index
|
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
deployment_guides/index
|
||||||
|
installation_guide/index
|
||||||
|
|
||||||
|
|
||||||
--------
|
--------
|
||||||
Projects
|
Projects
|
||||||
|
@ -3,37 +3,47 @@ Operation Guides
|
|||||||
================
|
================
|
||||||
|
|
||||||
Operation guides for StarlingX are release-specific.
|
Operation guides for StarlingX are release-specific.
|
||||||
The following list provides help on choosing the correct operations guide:
|
Each guide provides instruction on a specific StarlingX
|
||||||
|
configuration (e.g. All-in-one Simplex).
|
||||||
|
|
||||||
- The "current" release is the most recent officially released version of StarlingX.
|
***********************
|
||||||
Following are the current operation guides:
|
Latest official release
|
||||||
|
***********************
|
||||||
|
|
||||||
.. toctree::
|
The latest official release is the most recent officially
|
||||||
:maxdepth: 1
|
released version of StarlingX.
|
||||||
|
|
||||||
../api-ref/index
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
- The "latest" release is the forthcoming version under development.
|
../api-ref/index
|
||||||
Following are the latest operation guides:
|
|
||||||
|
|
||||||
.. toctree::
|
****************
|
||||||
:maxdepth: 1
|
Upcoming release
|
||||||
|
****************
|
||||||
|
|
||||||
../api-ref/index
|
The upcoming release is the forthcoming version under development.
|
||||||
latest/cli_reference/index
|
|
||||||
latest/data_network_config/index
|
|
||||||
latest/ceph_storage_config/index
|
|
||||||
latest/sdn_networking/index
|
|
||||||
latest/kubernetes_cluster_guide/index
|
|
||||||
latest/swift_config_management/index
|
|
||||||
latest/fault_management/index
|
|
||||||
latest/patching_guide/index
|
|
||||||
latest/upgrade_guide/index
|
|
||||||
|
|
||||||
- Following are operation guides for past StartlingX releases that have
|
.. toctree::
|
||||||
been archived:
|
:maxdepth: 1
|
||||||
|
|
||||||
* Currently, no archived operation guides exist.
|
../api-ref/index
|
||||||
|
latest/cli_reference/index
|
||||||
|
latest/data_network_config/index
|
||||||
|
latest/ceph_storage_config/index
|
||||||
|
latest/sdn_networking/index
|
||||||
|
latest/kubernetes_cluster_guide/index
|
||||||
|
latest/swift_config_management/index
|
||||||
|
latest/fault_management/index
|
||||||
|
latest/patching_guide/index
|
||||||
|
latest/upgrade_guide/index
|
||||||
|
|
||||||
|
|
||||||
|
*****************
|
||||||
|
Archived releases
|
||||||
|
*****************
|
||||||
|
|
||||||
|
Currently, no archived guides exist.
|
||||||
|
|
||||||
|
|
||||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||||
@ -45,7 +55,7 @@ The following list provides help on choosing the correct operations guide:
|
|||||||
becomes
|
becomes
|
||||||
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
||||||
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
||||||
the "current" string (i.e. 'git grep "current" *'). For each applicable occurence, make
|
the "current" string (i.e. 'git grep "current" *'). For each applicable occurrence, make
|
||||||
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
||||||
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
||||||
and "developer_guide" folders downward.
|
and "developer_guide" folders downward.
|
||||||
@ -57,7 +67,7 @@ The following list provides help on choosing the correct operations guide:
|
|||||||
becomes
|
becomes
|
||||||
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||||
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
||||||
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurence, make
|
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurrence, make
|
||||||
the call whether or not to convert the string to "current".
|
the call whether or not to convert the string to "current".
|
||||||
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
||||||
and "developer_guide" folders downward.
|
and "developer_guide" folders downward.
|
||||||
@ -90,3 +100,4 @@ The following list provides help on choosing the correct operations guide:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user