[Openstack-docs] Clearly marking trunk/ as the unstable version

Anne Gentle anne at openstack.org
Sat Jun 21 22:44:21 UTC 2014


On Sat, Jun 21, 2014 at 2:32 PM, Gauvain Pocentek <
gauvain.pocentek at objectif-libre.com> wrote:

> Le 2014-06-20 14:37, Anne Gentle a écrit :
>
>  Tom's patch is fine, let's see if that causes any rage.
>>
>> How about this: for the install guide we just don't publish to /trunk.
>>
>> I also like the django header but when I suggested using our existing
>> DRAFT watermark in the 1191447 but someone (can't recall who) said it
>> wouldn't be enough.
>>
>> The /trunk content was meant to be much less findable but over the
>> years it has become sought. It's probably time to delete it entirely
>> now that we have docs-draft links always available.
>> What do you think?
>>
>
> Could we imagine having a "hidden" build somewhere? It's nice to have the
> trunk available to check if bugs reported on icehouse have been fixed in
> the trunk.
>
>
I like this idea and have tried to have /trunk be unsearchable. If we
switch /icehouse to be /icehouse and /current and then create a /dev, and
never point to /dev links, could it be hidden?


> If it's too complicated or even not possible, then I think it's better to
> drop trunk/.
>
> Thanks,
> Gauvain
>
>  Anne
>>
>> On Fri, Jun 20, 2014 at 2:44 AM, Gauvain Pocentek
>> <gauvain.pocentek at objectif-libre.com> wrote:
>>
>>  Le 2014-06-20 09:18, Tom Fifield a écrit :
>>>
>>>  On 20/06/14 15:13, Gauvain Pocentek wrote:
>>>>
>>>>  We've received several bug reports about the auth_strategy nova option
>>>>> missing from our install procedure these last few days. These bugs are
>>>>> reported against the trunk doc, by people installing icehouse. The doc
>>>>> is in fact correct, both in trunk (the default for this option in juno
>>>>> has changed and we don't need to set it anymore), and in the icehouse
>>>>> branch (where the option is set up in the procedure).
>>>>>
>>>>> Would it be possible to mark the pages in the trunk/ subdirectory of
>>>>> docs.o.org [1] as "in progress" or "unstable", or anything that would
>>>>>
>>>>> explicitly tell the user that he might not be reading the correct page?
>>>>> We already have "juno" in the install-guide and config-ref titles, but
>>>>> I
>>>>> don't think it's visible enough.
>>>>>
>>>>
>>>> This is indeed a problem.
>>>>
>>>> I find it's quite similar to our Critical bug "Clearly mark outdated
>>>> doc pages" https://bugs.launchpad.net/openstack-manuals/+bug/1191447
>>>> [2]
>>>>
>>>> I've proposed a patch @ https://review.openstack.org/#/c/101428/ [3]
>>>> that
>>>>
>>>> will make it more obvious that trunk is juno, but I don't think it
>>>> solves the problem.
>>>>
>>>
>>> Users following the guide will very soon realize that this is not what
>>> they want with this patch. IMO that's a good thing. With the current
>>> trunk/, I'm quite sure that people end up thinking "the doc is not good, I
>>> can't get this thing to work". We really don't want them to think that :)
>>>
>>> When starting this thread I had the django documentation website in
>>> head. They have a relatively visible warning on the top of dev version
>>> pages: https://docs.djangoproject.com/en/dev/ [4] . If Tom's patch is
>>> not enough, we could look into implementing a similar feature.
>>>
>>>
>>> Gauvain
>>>
>>> _______________________________________________
>>> Openstack-docs mailing list
>>> Openstack-docs at lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs [5]
>>>
>>
>>
>>
>> Links:
>> ------
>> [1] http://docs.o.org
>> [2] https://bugs.launchpad.net/openstack-manuals/+bug/1191447
>> [3] https://review.openstack.org/#/c/101428/
>> [4] https://docs.djangoproject.com/en/dev/
>> [5] http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140621/db6c790d/attachment-0001.html>


More information about the Openstack-docs mailing list