[openstack-dev] Adding "not docs" banner to specs website?

Petr Kovar pkovar at redhat.com
Mon Mar 19 15:19:59 UTC 2018


On Mon, 19 Mar 2018 14:57:58 +0000
Jim Rollenhagen <jim at jimrollenhagen.com> wrote:

> Ironic (and surely other projects) have had to point out many times that
> specs are a point in time design discussion, and not completed
> documentation. It's obviously too much work to go back and update specs
> constantly.
> 
> What do folks think about a banner at the top of the specs website (or each
> individual spec) that points this out? I'm happy to do the work if we agree
> it's a good thing to do. My suggested wording:
> 
> "NOTE: specifications are a point-in-time design reference, not up-to-date
> feature documentation."

Might be a good idea to also include a pointer to
https://docs.openstack.org/.

Thanks,
pk



More information about the OpenStack-dev mailing list