[openstack-dev] [neutron] Multiple locations for documentation of features
carl at ecbaldwin.net
Mon Dec 7 17:18:29 UTC 2015
On Fri, Dec 4, 2015 at 12:22 PM, Henry Gessau <gessau at gmail.com> wrote:
> 1. RFE: "I want X"
> 2. Spec: "I plan to implement X like this"
> 3. devref: "How X is implemented and how to extend it"
> 4. OS docs: "API and guide for using X"
> Once X is implemented I don't want to have to go to 1 or 2 to find information
> on it. The devref may have a lot of content from the spec, but the spec is not
> maintained and the implementation may differ in some ways. The devref should
> be kept current with refactorings, etc. of the implementation.
Henry, I was also impressed by how clearly you communicated this.
This ought to be included somewhere prominently in our
doc/source/policies/ or somewhere like that.
More information about the OpenStack-dev