From bdeab685aad082fb76c47dc2e96fffa748a998eb Mon Sep 17 00:00:00 2001
From: Alex Kavanagh <alex.kavanagh@canonical.com>
Date: Wed, 7 Feb 2024 17:28:46 +0000
Subject: [PATCH] Add template for 2024.1 caracal release notes.

Change-Id: Ifa6414a80c1034d3f3e3f8793ff1ab8a294ddcbd
---
 doc/source/release-notes/2024.1-caracal.rst | 111 ++++++++++++++++++++
 doc/source/release-notes/index.rst          |  12 ++-
 2 files changed, 121 insertions(+), 2 deletions(-)
 create mode 100644 doc/source/release-notes/2024.1-caracal.rst

diff --git a/doc/source/release-notes/2024.1-caracal.rst b/doc/source/release-notes/2024.1-caracal.rst
new file mode 100644
index 00000000..ea4c26ee
--- /dev/null
+++ b/doc/source/release-notes/2024.1-caracal.rst
@@ -0,0 +1,111 @@
+============================================
+2024.1 (Caracal) (Draft version in progress)
+============================================
+
+The 2024.1 OpenStack Charms release includes updates for the charms
+described on the :doc:`../project/openstack-charms` page. As of this release,
+the project consists of <NUMBER-OF-STABLE-CHARMS> stable charms.
+
+For the list of bugs resolved in this release refer to the `2024.1
+milestone`_ in Launchpad.
+
+For scheduling information of past and future releases see the
+:doc:`../project/release-schedule`.
+
+.. note::
+
+   Release notes contents is superseded by updated information published in the
+   :doc:`index` (this guide) after the release of any given OpenStack Charms
+   version.
+
+.. important::
+
+   Always upgrade to the latest stable charms before making any major changes
+   to your cloud and before filing bug reports. Note that charm upgrades and
+   OpenStack upgrades are functionally different. For instructions on
+   performing the different upgrade types see the
+   :doc:`../admin/upgrades/overview` page.
+
+.. contents:: Summary of changes:
+   :local:
+   :depth: 2
+   :backlinks: top
+
+New stable charms
+-----------------
+
+<TITLE>
+~~~~~~~
+
+New stable charm features
+-------------------------
+
+With each new feature, there is a corresponding example bundle in the form of a
+test bundle, and/or a section in the current guide (Charm Guide) that details
+its usage. Test bundles are located in the ``src/tests/bundles`` directory of
+the relevant charm repository (see all `charm repositories`_).
+
+<TITLE>
+~~~~~~~
+
+Documentation updates
+---------------------
+
+<TITLE>
+~~~~~~~
+
+New tech-preview charms
+-----------------------
+
+<TITLE>
+~~~~~~~
+
+New tech-preview charm features
+-------------------------------
+
+<TITLE>
+~~~~~~~
+
+Informational notices
+---------------------
+
+<TITLE>
+~~~~~~~
+
+Deprecation notices
+-------------------
+
+<TITLE>
+~~~~~~~
+
+Removed features
+----------------
+
+<TITLE>
+~~~~~~~
+
+Removed charms
+--------------
+
+<TITLE>
+~~~~~~~
+
+Issues discovered during this release cycle
+-------------------------------------------
+
+<TITLE>
+~~~~~~~
+
+Changes backported to this release
+----------------------------------
+
+*none at this time*
+
+.. LINKS
+.. _2024.1 milestone: https://launchpad.net/openstack-charms/+milestone/2024.1
+.. _Upgrades overview: https://docs.openstack.org/charm-guide/latest/admin/upgrades/overview.html
+.. _charm repositories: https://opendev.org/openstack?sort=alphabetically&q=charm-&tab=
+
+.. COMMITS
+
+.. BUGS
diff --git a/doc/source/release-notes/index.rst b/doc/source/release-notes/index.rst
index 84a939e0..954858b2 100644
--- a/doc/source/release-notes/index.rst
+++ b/doc/source/release-notes/index.rst
@@ -6,15 +6,23 @@ This page lists the release notes for every version of OpenStack Charms.
 
 Under development:
 
-* :doc:`2023.2-bobcat`
+* :doc:`2024.1-caracal`
 
 Latest stable:
 
-* :doc:`2023.1-antelope`
+* :doc:`2023.2-bobcat`
 * :doc:`42_Trilio`
 
 Older versions listed by year of release:
 
+.. list-table::
+   :header-rows: 0
+   :widths: 20 20
+   :stub-columns: 1
+
+   * - 2023
+     - :doc:`2023.1-antelope`
+
 .. list-table::
    :header-rows: 0
    :widths: 20 20 20