Open Stack

On 9/6/16, 2:02 PM, "Ihar Hrachyshka" <ihrachys at redhat.com> wrote:

>Akihiro Motoki <amotoki at gmail.com> wrote:
>
>> What releases should we support in API references?
>> There are several options.
>>
>> 1. The latest stable release + master
>> 2. All supported stable releases + master
>> 3. more older releases too?
>>
>> Option 2 sounds reasonable to me.
>>
>> This question is raised in the neutron api-ref patch [1].
>> This patch drops the API reference of LBaaS v1 which was dropped in
>> Newton release.
>> At least Newton is not released yet, so I think it is better to keep
>> it until Newton is released.
>>
>> I would like to get a community consensus before moving this patch
>>forward.
>>
>> Thanks,
>> Akihiro
>
>Since neutron-lib is branched on stable/* boundary, I feel that it would
>be
>fine to keep one-to-one relationship between neutron and neutron-lib
>api-ref branches.
>
>The only reason why keeping all stable branches described in master would
>
>be ease of maintenance, because you don¹t need to backport any api-ref
>related fixes to previous branches.
>
>So, I would not vote for any of 3 options suggested. Instead, I would
>keep
>master api-ref documenting just the latest (master) neutron API, and keep
>
>stable releases documented in corresponding branches whenever they differ.
>
>Of course it will require to solve an issue of publishing api-ref for
>each
>of supported branches instead of just master.
>
>Ihar

I¹m inclined to agree with Ihar on this. Now that the api ref lives in
neutron-lib I think it makes sense for it to track master. If it lived
elsewhere and wasn¹t so closely coupled with release branches then option
2 would be best, but as Ihar says, the ref for older releases can belong
in the relevant branch.

John


________________________________
Rackspace Limited is a company registered in England & Wales (company registered number 03897010) whose registered office is at 5 Millington Road, Hyde Park Hayes, Middlesex UB3 4AZ. Rackspace Limited privacy policy can be viewed at www.rackspace.co.uk/legal/privacy-policy - This e-mail message may contain confidential or privileged information intended for the recipient. Any dissemination, distribution or copying of the enclosed material is prohibited. If you receive this transmission in error, please notify us immediately by e-mail at abuse at rackspace.com and delete the original message. Your cooperation is appreciated.