* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*                                                             *
* This is a template to be used for future release notes.     *
* Make a copy, remove this notice, and use the placeholders.  *
*                                                             *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

===========================================
<CHARM_RELEASE> (Draft version in progress)
===========================================

The <CHARM_RELEASE> 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 `<CHARM_RELEASE>
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
.. _<CHARM_RELEASE> milestone: https://launchpad.net/openstack-charms/+milestone/<CHARM_RELEASE>
.. _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