[openstack-dev] [docs][release][stable][ptl][infra] Strategic discussion regarding the future of documentation for EOL releases

Doug Hellmann doug at doughellmann.com
Fri Jul 28 12:34:18 UTC 2017

Excerpts from Andreas Jaeger's message of 2017-07-28 09:12:59 +0200:
> On 2017-07-27 21:40, Doug Hellmann wrote:
> > [...]
> > Please encourage everyone there to explore options that require the
> > least amount of effort. An ideal solution is one we can implement
> > without heroic efforts or having to recruit an army of contributors.
> I agree with the points made in general and want to stress we need
> something that reduces our efforts.
> Two more ideas:
> 1) What about enhancing the openstackdocstheme to automatically add a
> watermark if we publish a stable branch document?
> Like on https://docs.openstack.org/mitaka/config-reference/ - which also
> includes a warning that the branch is EOL. What about adding at *start*
> of a branch a message to the index page like "This is the document for
> the SERIES release. Please see https://releases.openstack.org/ whether
> the SERIES release is still supported by the OpenStack community."

I like that. We could add that information to a sidebar or footer on
every page.

> 2) The openstackdocstheme has the report a bug link feature. We can
> disable this. If we EOL docs (so, push a change before we eol them), we
> could remove the setting so that "report a bug" does not work.

I wasn't able to come up with a way to disable the link without
triggering a new build. I didn't want us to have to land a patch in each
repo as part of marking it EOL, but if we're going to do that to remove
the installation guide anyway then maybe we can disable the bug link at
the same time.


More information about the OpenStack-dev mailing list