[docs] Add reno to help in creating release notes 75/72775/1
authorEmma Foley <efoley@redhat.com>
Mon, 5 Jul 2021 15:40:23 +0000 (16:40 +0100)
committerEmma Foley <efoley@redhat.com>
Wed, 14 Jul 2021 16:14:30 +0000 (17:14 +0100)
commit0f8a84a598cbbead4939dbe85b00f722289b1662
tree2f7352d3c5fb18f2331a84fddfe081599d2faf43
parent283d8a7c2a4d193ef059f993140e0075c6494ac1
[docs] Add reno to help in creating release notes

Reno[1] is used to create release notes. It can be used in conjunction
with sphinx to automatically create and publish release notes. In this
case it is being added to help with release notes collation at the end of
the release cycle.

There is a possibility that it can be more fully integrated later, if
there is need for it.

For the moment, release notes can be outputted using tox::

  tox -e docs-releasenotes

Release notes can be added to features using::

  reno new slug-goes-here

where slug-goes-here is combined with a random suffic to create a unique
name for the release note.

[1] https://docs.openstack.org/reno/latest/

Change-Id: Id7f113fa4817585bb429503ff3491c633a4ce8e2
Signed-off-by: Emma Foley <efoley@redhat.com>
docs/release/release-notes/config.yaml [new file with mode: 0644]
docs/release/release-notes/notes/.placeholder [new file with mode: 0644]
docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml [new file with mode: 0644]
docs/requirements.txt
tox.ini