[openstack-dev] [neutron] Multiple locations for documentation of features

Neil Jerram Neil.Jerram at metaswitch.com
Tue Dec 8 10:42:35 UTC 2015


On 07/12/15 17:42, Sean M. Collins wrote:
> On Mon, Dec 07, 2015 at 12:18:29PM EST, Carl Baldwin wrote:
>> 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.
>>
> +10000 for Henry's great answer, and +10000 for Carl's suggestion!
>

I've suggested a change for this at
https://review.openstack.org/#/c/254669/.  Please take a look.

    Neil




More information about the OpenStack-dev mailing list