Age | Commit message (Collapse) | Author | Files | Lines |
|
Added a tox target for reno, so new notes can be creted using::
tox -e docs-create-note -- slug-goes-here
Signed-off-by: Emma Foley <efoley@redhat.com>
Change-Id: Ie3b7a3326e80c4d1d49fed42900ce4d31fa3a2ba
|
|
The template for release notes wasn't conforming to the expected
headings. A template was added to the config.
To generate a new note (from the base directory in the repo), use::
reno --rel-notes-dir docs/release/release-notes/ new slug-goes-here
The release notes are also included as part of the docs build, and the
existing releases notes have been renamed accordingly.
Signed-off-by: Emma Foley <efoley@redhat.com>
Change-Id: I05d1950b37f266bb6eb3515b3660665cfd5c1d8b
|
|
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>
|