From 026fc0186efb992f18895e989806eed411a3cc04 Mon Sep 17 00:00:00 2001
From: Clark Boylan <clark.boylan@gmail.com>
Date: Tue, 1 Oct 2024 14:30:42 -0700
Subject: [PATCH] Render a graph showing the SLURP and not SLURP upgrade paths

I think visual representation can help people understand the practical
effects of the SLURP releases on their upgrade options. Lets add one
using graphviz to do the rendering for us.

Change-Id: Ic28c8ad4bc84f094a37b38037a6859d725e85f51
---
 bindep.txt           |  2 ++
 doc/source/conf.py   |  1 +
 doc/source/index.rst | 28 +++++++++++++++++++++++++++-
 3 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/bindep.txt b/bindep.txt
index 576a3c047c..cb8a13619a 100644
--- a/bindep.txt
+++ b/bindep.txt
@@ -9,3 +9,5 @@ git-review [platform:ubuntu]
 libre2-dev [platform:ubuntu]
 # This is for python-pcre which is a dependency of whereto.
 libpcre3-dev [platform:ubuntu]
+# For SLURP graphic rendering
+graphviz [doc]
diff --git a/doc/source/conf.py b/doc/source/conf.py
index be2138dbba..76ad01219a 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -19,6 +19,7 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'deliverables',
+    'sphinx.ext.graphviz',
     'sphinxcontrib.datatemplates',
     'ics',
     'reviewinbox',
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e21c7e9be6..38a12992a8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -95,7 +95,33 @@ Releases with Skip Level Upgrade Release Process (SLURP)
 Releases can be marked as `Skip Level Upgrade Release Process`_ (or
 `SLURP`) releases. This practically means, that upgrades will be
 supported between these (`SLURP`) releases, in addition to between
-adjacent major releases.
+adjacent major releases. For example the upgrade paths starting with
+the 2023.1 Antelope release look like this:
+
+.. graphviz::
+
+   digraph openstack_releases {
+     label="OpenStack Upgrade Paths"
+     splines=false;
+     nodesep=1;
+     rankdir="LR";
+     node [shape=box];
+
+     A [label="2023.1\nAntelope"];
+     C [label="2024.1\nCaracal"];
+     B [label="2023.2\nBobcat"];
+     E [label="2025.1\nEpoxy"];
+     D [label="2024.2\nDalmatian"];
+
+     A -> C [xlabel="SLURP"];
+     A -> B;
+     B -> C;
+
+     C -> E [xlabel="SLURP"];
+     C -> D;
+     D -> E;
+
+   }
 
 .. _Skip Level Upgrade Release Process: https://governance.openstack.org/tc/resolutions/20220210-release-cadence-adjustment.html