From 6d4ef034add2e0c141c8b027fa8e708b0dca970c Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Wed, 31 Mar 2021 12:10:40 -0500 Subject: [PATCH] doc/releases: add major headings for releases This cleans up the index on the left so that the release name/series is listed instead of a zillion point releases. Also, drop the separate page for archived releases, so that the left-hand index behaves well. Signed-off-by: Sage Weil --- doc/releases/archived-index.rst | 20 -------------------- doc/releases/argonaut.rst | 8 ++++++++ doc/releases/bobtail.rst | 7 +++++++ doc/releases/cuttlefish.rst | 8 ++++++++ doc/releases/dumpling.rst | 7 +++++++ doc/releases/emperor.rst | 7 +++++++ doc/releases/firefly.rst | 7 +++++++ doc/releases/giant.rst | 8 ++++++++ doc/releases/hammer.rst | 7 +++++++ doc/releases/index.rst | 26 ++++++++++++++++++++++---- doc/releases/infernalis.rst | 8 ++++++++ doc/releases/jewel.rst | 8 ++++++++ doc/releases/kraken.rst | 8 ++++++++ doc/releases/luminous.rst | 7 +++++++ doc/releases/mimic.rst | 7 +++++++ doc/releases/nautilus.rst | 8 ++++++++ doc/releases/octopus.rst | 8 ++++++++ doc/releases/pacific.rst | 8 ++++++++ 18 files changed, 143 insertions(+), 24 deletions(-) delete mode 100644 doc/releases/archived-index.rst diff --git a/doc/releases/archived-index.rst b/doc/releases/archived-index.rst deleted file mode 100644 index 15eeed8a50c..00000000000 --- a/doc/releases/archived-index.rst +++ /dev/null @@ -1,20 +0,0 @@ -================= -Archived Releases -================= - -.. toctree:: - :maxdepth: 1 - - Mimic - Luminous - Kraken - Jewel - Infernalis - Hammer - Giant - Firefly - Emperor - Dumpling - Cuttlefish - Bobtail - Argonaut diff --git a/doc/releases/argonaut.rst b/doc/releases/argonaut.rst index 4c2806244ea..409d1af9133 100644 --- a/doc/releases/argonaut.rst +++ b/doc/releases/argonaut.rst @@ -1,3 +1,11 @@ +======== +Argonaut +======== + +Argonaut is the first stable release of Ceph. It is named after a +genus of octopuses, sometimes also referred to as paper nautiluses. + + v0.48.3 "argonaut" ================== diff --git a/doc/releases/bobtail.rst b/doc/releases/bobtail.rst index d6e0b0e3627..a6695bf7726 100644 --- a/doc/releases/bobtail.rst +++ b/doc/releases/bobtail.rst @@ -1,3 +1,10 @@ +======= +Bobtail +======= + +Bobtail is the second stable release of Ceph. It is named after the +bobtail squid (order Sepiolida), a group of cephalopods closely related to cuttlefish. + v0.56.7 "bobtail" ================= diff --git a/doc/releases/cuttlefish.rst b/doc/releases/cuttlefish.rst index ac0597183a9..3e522fd3f0d 100644 --- a/doc/releases/cuttlefish.rst +++ b/doc/releases/cuttlefish.rst @@ -1,3 +1,11 @@ +========== +Cuttlefish +========== + +Cuttlefish is the 3rd stable release of Ceph. It is named after a type +of cephalopod (order Sepiida) characterized by a unique internal shell, the +cuttlebone, which is used for control of bouyancy. + v0.61.9 "Cuttlefish" ==================== diff --git a/doc/releases/dumpling.rst b/doc/releases/dumpling.rst index 32febd67781..95e99884992 100644 --- a/doc/releases/dumpling.rst +++ b/doc/releases/dumpling.rst @@ -1,3 +1,10 @@ +======== +Dumpling +======== + +Dumpling is the 4th stable release of Ceph. It is named after the +dumpling squid (Euprymna tasmanica). + v0.67.12 "Dumpling" (draft) =========================== diff --git a/doc/releases/emperor.rst b/doc/releases/emperor.rst index 20823f51f80..3c0bcb782d8 100644 --- a/doc/releases/emperor.rst +++ b/doc/releases/emperor.rst @@ -1,3 +1,10 @@ +======= +Emperor +======= + +Emperor is the 5th stable release of Ceph. It is named after the emperor squid. + + v0.72.3 Emperor (pending release) ================================= diff --git a/doc/releases/firefly.rst b/doc/releases/firefly.rst index 5847bd1b9e5..6244600898e 100644 --- a/doc/releases/firefly.rst +++ b/doc/releases/firefly.rst @@ -1,3 +1,10 @@ +======= +Firefly +======= + +Firefly is the 6th stable release of Ceph. It is named after the +firefly squid (Watasenia scintillans). + v0.80.11 Firefly ================ diff --git a/doc/releases/giant.rst b/doc/releases/giant.rst index d6ee8c097d8..da330f15983 100644 --- a/doc/releases/giant.rst +++ b/doc/releases/giant.rst @@ -1,3 +1,11 @@ +===== +Giant +===== + +Giant is the 7th stable release of Ceph. It is named after the giant +squid (Architeuthis dux). + + v0.87.2 Giant ============= diff --git a/doc/releases/hammer.rst b/doc/releases/hammer.rst index 06dd17c9bf6..785d0c2b434 100644 --- a/doc/releases/hammer.rst +++ b/doc/releases/hammer.rst @@ -1,3 +1,10 @@ +====== +Hammer +====== + +Hammer is the 8th stable release of Ceph. It is named after the +hammer octopus (Octopus australis). + v0.94.10 Hammer =============== diff --git a/doc/releases/index.rst b/doc/releases/index.rst index 6a9a8301f5e..9390b425595 100644 --- a/doc/releases/index.rst +++ b/doc/releases/index.rst @@ -10,17 +10,35 @@ Ceph Releases (index) Active Releases --------------- +The following Ceph releases are actively maintained and receive periodic backports and +security fixes. + .. toctree:: :maxdepth: 1 - Pacific - Octopus - Nautilus + Pacific (v16.2.*) + Octopus (v15.2.*) + Nautilus (v14.2.*) Archived Releases ----------------- +The following older Ceph releases are no longer maintained (do not +receive bug fixes or backports). + .. toctree:: :maxdepth: 1 - Archived releases index + Mimic (v13.2.*) + Luminous (v12.2.*) + Kraken (v11.2.*) + Jewel (v10.2.*) + Infernalis (v9.2.*) + Hammer (v0.94.*) + Giant (v0.87.*) + Firefly (v0.80.*) + Emperor (v0.72.*) + Dumpling (v0.67.*) + Cuttlefish (v0.61.*) + Bobtail (v0.56.*) + Argonaut (v0.48.*) diff --git a/doc/releases/infernalis.rst b/doc/releases/infernalis.rst index 14b756c0aff..43a2af3861b 100644 --- a/doc/releases/infernalis.rst +++ b/doc/releases/infernalis.rst @@ -1,5 +1,13 @@ .. _infernalis-release-notes: +========== +Infernalis +========== + +Infernalis is the 9th stable release of Ceph. It is named after the +vampire squid (Vampyroteuthis infernalis, the "vampire squid from +hell"). + v9.2.1 Infernalis ================= diff --git a/doc/releases/jewel.rst b/doc/releases/jewel.rst index 6bd0d8c37c7..951dc5d82d7 100644 --- a/doc/releases/jewel.rst +++ b/doc/releases/jewel.rst @@ -1,3 +1,11 @@ +===== +Jewel +===== + +Jewel is the 10th stable release of Ceph. It is named after the jewel +squid (Histioteuthis reversa). + + v10.2.11 Jewel ============== diff --git a/doc/releases/kraken.rst b/doc/releases/kraken.rst index 3e6774e7ab6..3d39e3293b3 100644 --- a/doc/releases/kraken.rst +++ b/doc/releases/kraken.rst @@ -1,3 +1,11 @@ +====== +Kraken +====== + +Kraken is the 11th stable release of Ceph. It is named after the +mythical kraken, a legendary sea monster in Scandinavian folklore with +cephalopod-like appearance. + v11.2.1 Kraken ============== diff --git a/doc/releases/luminous.rst b/doc/releases/luminous.rst index 4c20d7f5763..3d01d71990e 100644 --- a/doc/releases/luminous.rst +++ b/doc/releases/luminous.rst @@ -1,3 +1,10 @@ +======== +Luminous +======== + +Luminous is the 12th stable release of Ceph. It is named after the +luminous squid (watasenia scintillans, aka firefly squid). + v12.2.13 Luminous ================= diff --git a/doc/releases/mimic.rst b/doc/releases/mimic.rst index e98261c1192..c811556e34d 100644 --- a/doc/releases/mimic.rst +++ b/doc/releases/mimic.rst @@ -1,3 +1,10 @@ +===== +Mimic +===== + +Mimic is the 13th stable release of Ceph. It is named after the mimic +octopus (thaumoctopus mimicus). + v13.2.10 Mimic ============== diff --git a/doc/releases/nautilus.rst b/doc/releases/nautilus.rst index 8b664a82c1a..5dc4866654f 100644 --- a/doc/releases/nautilus.rst +++ b/doc/releases/nautilus.rst @@ -1,3 +1,11 @@ +======== +Nautilus +======== + +Nautilus is the 14th stable release of Ceph. It is named after the +nautilus, a family of cephalopods characterized by a whorled shell. + + v14.2.19 Nautilus ================= diff --git a/doc/releases/octopus.rst b/doc/releases/octopus.rst index 919b92e1f11..e4112b9e57e 100644 --- a/doc/releases/octopus.rst +++ b/doc/releases/octopus.rst @@ -1,3 +1,11 @@ +======= +Octopus +======= + +Octopus is the 15th stable release of Ceph. It is named after an +order of 8-limbed cephalopods. + + v15.2.9 Octopus =============== diff --git a/doc/releases/pacific.rst b/doc/releases/pacific.rst index 3b7652e1fc5..f9438bfb06d 100644 --- a/doc/releases/pacific.rst +++ b/doc/releases/pacific.rst @@ -1,3 +1,11 @@ +======= +Pacific +======= + +Pacific is the 16th stable release of Ceph. It is named after the +giant pacific octopus (Enteroctopus dofleini). + + v16.2.0 Pacific =============== -- 2.39.5