I'm all for the idea, although that may be because I've been been one of the people in the past attempting to assist people who have found specs, and who are are confused or frustrated. I believe it is because some people latch on to the highly technical design documents when they can't find $complex thing in $complex documentation easily.
-Julia On Mon, Mar 19, 2018 at 7:57 AM, Jim Rollenhagen <j...@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." > > // jim > > __________________________________________________________________________ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > On Mon, Mar 19, 2018 at 7:57 AM, Jim Rollenhagen <j...@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." > > // jim > > __________________________________________________________________________ > OpenStack Development Mailing List (not for usage questions) > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > __________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
