Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.
Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.
This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.
Change-Id: Ia0c8d7dc346182fde095eebb82eeeb70fc1b9770
In the release notes build, openstackdocstheme is specified
in the sphinx extension list, but it is actually not used.
This commit configures openstackdocstheme as suggested in
the openstackdocstheme document.
Also specifies display_toc False in html_theme_options.
This prevents openstackdocstheme to add the local TOC automatically.
OSC has several releases during a single development cycle and
it leads to a long TOC at the top of individual pages.
It loses the readability and we can see version numbers in the
left sidebar, so we can safely disable the local TOC in
the release notes.
[1] https://docs.openstack.org/openstackdocstheme/latest/
Change-Id: Iae08d309f7589bb13a1766f6fded70673ba24047
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
release notes.
Note that this repository might not get translated release notes - or
no translations at all - but we add the entry here nevertheless to
prepare for it.
Change-Id: Ib265f919e176f048f6e56bde47db3d99b3dd993e
In order to support automatically updating the release notes when we
create stable branches, we want the pages to be in a standard order.
This patch updates the order to be reverse chronological, so the most
recent notes appear at the top.
Change-Id: Ib364dcc8eb31275a31c83b68d7914263b183e393
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Give the 2.x series its own release notes page, put the 3.x notes into
the 'current' series page. This removes the OpenStack development cycle
name from the release notes.
We follow the intermediary release model, however the association with
the common cycle release is something that we do not need to reflect in
the doc structure. We want users to use the current version even with
older clouds, not to think they need to use a 'Mitaka' OSC with a Mitaka
cloud.
Change-Id: Idbb6844824d50e5cd0fa64871b5aa625d4d237af
Moving the old release notes into the Reno releasenots tree broke
the embedded :doc: roles. Restore these using sphinx.ext.extlinks to
manage the URL to the OSC docs.
Add the following aliases:
* lpbug - generic Launchpad bug :lpbug:`123456`
* oscbp - OSC blueprints :oscbp:`Blue Print <bp-name>`
* oscdoc - OSC Docs :oscdoc:`Comamnd List <command-list>`
Change-Id: Iecfdd666d961c35f0ccb3b9f10df1d2620cb099f
Currently OSC release notes are in the OpenStack releasenote
site. There is a collection of old non-reno release notes in
our docs folder. Move the non-reno release notes to the
reno directionary.
Change-Id: Ie51fd1e1115d606e5d2739014d3720eedc8dc225
