diff options
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/release/release-notes/config.yaml | 35 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/release-notes/kali-release-notes.rst | 6 | ||||
| -rw-r--r-- | docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml | 5 | ||||
| -rw-r--r-- | docs/release/release-notes/old-release-notes.rst (renamed from docs/release/release-notes/release-notes.rst) | 6 | ||||
| -rw-r--r-- | docs/release/release-notes/unreleased.rst | 10 |
7 files changed, 61 insertions, 10 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3c4453e7..041afc56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1 +1,3 @@ from docs_conf.conf import * + +extensions = ['reno.sphinxext'] diff --git a/docs/release/release-notes/config.yaml b/docs/release/release-notes/config.yaml index 5c2b7a7b..ae56f82d 100644 --- a/docs/release/release-notes/config.yaml +++ b/docs/release/release-notes/config.yaml @@ -1,3 +1,4 @@ +--- unreleased_version_title: 'Lakelse' sections: - [ features, New Features ] @@ -15,3 +16,37 @@ branch_name_prefix: stable/ prelude_section_name: release_summary stop_at_branch_base: False collapse_pre_releases: False +template: | + release_summary: > + Add a summary of the change here. All sections (including this one) are + optional, and if they are not needed, you can completely remove that section. + Each section is rendered separately, this mean you should assume each item + below is self-contained, and should not depend on info in any other section. + This means repetition is sometimes necessary, and this is okay. + features: + - | + List new features here + testing: + - | + List new testing notes here + docs: + - | + List documentation updates here + containers: + - | + List container updates here + ansible: + - | + List ansible playbook updates here + build: + - | + List build script updates here + fixes: + - | + List normal bug fixes here + deprecations: + - | + List deprecations here + other: + - | + List other notes here diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index df4696a5..6185fc97 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -4,13 +4,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Anuket, Intel Corporation and others. -================================================== +============================== Anuket Barometer Release Notes -================================================== +============================== .. toctree:: :maxdepth: 1 + unreleased kali-release-notes - release-notes + old-release-notes diff --git a/docs/release/release-notes/kali-release-notes.rst b/docs/release/release-notes/kali-release-notes.rst index 250becc1..cac7325b 100644 --- a/docs/release/release-notes/kali-release-notes.rst +++ b/docs/release/release-notes/kali-release-notes.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -============================ -Barometer Kali Release Notes -============================ +================== +Kali Release Notes +================== This document provides the release notes for Kali release of Barometer. diff --git a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml index 4dbf2e88..c0e8c7e9 100644 --- a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml +++ b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml @@ -1,4 +1,7 @@ --- +documentation: + - | + Release notes are now automatically generated and included in the documentation using `reno <https://docs.openstack.org/reno/latest/index.html>`_. other: - | - Add reno and corresponding tox jobs to make compiling release notes easier + Add `reno <https://docs.openstack.org/reno/latest/index.html#>`_ and corresponding tox jobs to make compiling release notes easier diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/old-release-notes.rst index 75a2e391..d5c1b7e5 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/old-release-notes.rst @@ -1,9 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -====================================================================== -Barometer Release Notes -====================================================================== +=================== +Older Release Notes +=================== This document provides the release notes for Euphrates release of Barometer. diff --git a/docs/release/release-notes/unreleased.rst b/docs/release/release-notes/unreleased.rst new file mode 100644 index 00000000..e3b0dccc --- /dev/null +++ b/docs/release/release-notes/unreleased.rst @@ -0,0 +1,10 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Anuket and others. + +============================ +Current Series Release Notes +============================ + +.. release-notes:: + :relnotessubdir: docs/release/release-notes/ |