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

Sean McGinnis sean.mcginnis at gmx.com
Mon Mar 19 15:07:54 UTC 2018

On Mon, Mar 19, 2018 at 02:57:58PM +0000, Jim Rollenhagen 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."
> // jim

I like that idea. There have been several times where this has caused
confusion. If there was some sort of notification on the page, that may make it
more likely that random web search readers will understand that they are not
reading "official" documentation.

More information about the OpenStack-dev mailing list