doc/releases: access main releases page from top-level TOC

Before this commit, one had to go through the releases index to get to the main releases page. This should be the other way around. Also, the main releases page should not be called "schedule.rst" - while it contains a historical timeline, that's its principal purpose. Signed-off-by: Nathan Cutler <ncutler@suse.com>
ceph · Sep 27, 2019 · a959c64 · a959c64
1 parent 517337e
commit a959c64
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 31 deletions.
diff --git a/doc/dev/repo-access.rst b/doc/dev/repo-access.rst
@@ -6,7 +6,7 @@ Special branches
 
 * ``master``: current tip (integration branch)
 * Release branches (for example ``luminous``) corresponding to the releases
-  listed at :ref:`ceph-releases`
+  listed at :ref:`ceph-releases-index`
 
 Rules
 -----

diff --git a/doc/index.rst b/doc/index.rst
@@ -107,5 +107,6 @@ about Ceph, see our `Architecture`_ section.
    dev/internals
    governance
    ceph-volume/index
+   releases/general
    releases/index
    Glossary <glossary>
diff --git a/doc/install/get-packages.rst b/doc/install/get-packages.rst
@@ -83,7 +83,7 @@ You may find releases for CentOS/RHEL and others (installed with YUM) at::
 
 	https://download.ceph.com/rpm-{release-name}
 
-The major releases of Ceph are summarized at: :ref:`ceph-releases`
+The major releases of Ceph are summarized at: :ref:`ceph-releases-general`
 
 Every second major release is considered Long Term Stable (LTS). Critical
 bugfixes are backported to LTS releases until their retirement. Since retired

diff --git a/doc/releases/archived-index.rst b/doc/releases/archived-index.rst
@@ -5,6 +5,7 @@ Archived Releases
 .. toctree::
    :maxdepth: 1
 
+   Jewel <jewel>
    Kraken <kraken>
    Infernalis <infernalis>
    Hammer <hammer>

diff --git a/doc/releases/schedule.rst → doc/releases/general.rst b/doc/releases/schedule.rst → doc/releases/general.rst
@@ -1,12 +1,25 @@
-=============
-Ceph Releases
-=============
+.. _ceph-releases-general:
+
+=======================
+Ceph Releases (general)
+=======================
+
+.. toctree::
+    :maxdepth: 1
 
 Current
 -------
 
 .. ceph_releases:: releases.yml
 
+The lifetime of a stable release series is calculated to be approximately 24
+months (i.e., two 12 month release cycles) after the month of the first release.
+For example, Mimic (13.2.z) will reach end of life (EOL) shortly after Octopus
+(15.2.0) is released. The lifetime of a release may vary because it depends on
+how quickly the stable releases are published.
+
+Detailed information on all releases, past and present, can be found at :ref:`ceph-releases-index`
+
 Timeline
 --------
 
@@ -242,18 +255,13 @@ For each stable release:
 * The `stable releases and backport team <http://tracker.ceph.com/projects/ceph-releases/wiki>`_
   publishes ``point releases`` including fixes that have been backported to the stable release.
 
-In the timeline above, the life time of a stable release series is
-calculated to be approximately 24 months (i.e., two 12 month release
-cycles) after the month of the first release.  For example, Mimic
-(13.2.z) will reach end of life (EOL) shortly after Octopus (15.2.0) is
-released.  The lifetime of a release may vary because it depends on how
-quickly the stable releases are published.
-
-The life time for Jewel and Kraken are slightly different.  Prior to
-Luminous, only every other stable release was an "LTS" release.
-Therefore,
+In the case of Jewel and Kraken, the lifetime was slightly different than
+described above. Prior to Luminous, only every other stable release was an "LTS"
+release. Therefore,
 
-* Upgrades are supported from Jewel -> Kraken -> Luminous and Jewel -> Luminous.
-* Upgrades from Jewel or Kraken must upgrade to Luminous first before proceeding further (e.g., Kraken -> Luminous -> Mimic but not Kraken -> Mimic).
-* Jewel will be maintained until Mimic is released in the spring of 2018.
+* Upgrade scenarios "Jewel -> Kraken -> Luminous" and "Jewel -> Luminous" were
+  expected to work.
+* Upgrades from Jewel or Kraken must upgrade to Luminous first before proceeding
+  further (e.g., Kraken -> Luminous -> Mimic but not Kraken -> Mimic).
+* Jewel was maintained until Mimic was released (June 2018).
 * Kraken is no longer maintained.
diff --git a/doc/releases/index.rst b/doc/releases/index.rst
@@ -1,31 +1,24 @@
-=============
-Ceph Releases
-=============
+.. _ceph-releases-index:
 
-.. _ceph-releases:
-
-Release Index
--------------
+=====================
+Ceph Releases (index)
+=====================
 
 .. toctree::
    :maxdepth: 1
 
-   Release Schedule <schedule>
-
-
 Active Releases
-~~~~~~~~~~~~~~~
+---------------
 
 .. toctree::
    :maxdepth: 1
 
    Nautilus <nautilus>
    Mimic <mimic>
    Luminous <luminous>
-   Jewel <jewel>
 
 Archived Releases
-~~~~~~~~~~~~~~~~~
+-----------------
 
 .. toctree::
    :maxdepth: 1