doc/releases: Add ordering comment to releases.yml

Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
(cherry picked from commit 2290a904bd6a3194f77b76d7deb0c9d24c8b4b93)

diff --git a/doc/releases/releases.yml b/doc/releases/releases.yml
index 8bc243d28385fa78de150d4b4efc1a4da381f8a1..e54f6b14b8091a32f8dd5c62c572527d0ca86409 100644 (file)
--- a/doc/releases/releases.yml
+++ b/doc/releases/releases.yml
@@ -1,5 +1,5 @@
 #
-# there are two sections
+# There are two sections
 #
 # releases: ... for named releases
 # development: ... for dev releases
@@ -11,6 +11,10 @@
 #
 # If a version might represent an actual number (e.g. 0.80) quote it.
 #
+# Note that in order for the Gantt chart to properly reflect the latest version
+#      of a major release, the versions within a `releases` list MUST be
+#      in descending order.
+
 releases:
   reef:
     target_eol: 2025-08-01