[OpenStack-docs] hyphens for file names

Anne Gentle annegentle at justwriteclick.com
Fri Jul 29 20:02:52 UTC 2016


On Fri, Jul 29, 2016 at 2:33 PM, Akihiro Motoki <amotoki at gmail.com> wrote:
> As I commented in the review, this effort will break existing links in
> the versioned documents (mitaka and liberty).
> I think it is better to fix links in the stable guide too. It is
> better to clarify the scope of this effort.

Oh, great point, thank you.

So, affecting newton, mitaka, and liberty files, but only backport to
mitaka and liberty for the cli-reference files? (I would prefer to not
backport for common, for example.)

>
> Regarding assignees, I can volunteer for common files (or others).
> I usually check the networking guide and common files are used in it
> and am familiar with what we do in our repo.

Much appreciated!
Anne

>
> Thanks,
> Akihiro
>
> 2016-07-30 3:44 GMT+09:00 Anne Gentle <annegentle at justwriteclick.com>:
>> Hi again all,
>>
>> Thanks so much for your responses and willingness to help.
>>
>> Based on the spec review, we do think this work is possible in the
>> Newton release, and I'd like to find assignees for each "directory"
>> and add those to the spec at https://review.openstack.org/#/c/345639/
>> before we merge the spec.
>>
>> I think I see it as:
>>
>> admin-guide: Anne Gentle
>> cli-reference: Kato Tomoyuki
>> config-reference: Kato Tomoyuki
>> common: needs an owner, Oleana are you interested and available?
>> ops-guide: needs an owner
>> user-guide: needs an owner
>>
>> Edgar, the networking guide didn't have any underscores except for
>> common files, so you could pick up the common files if you want!
>>
>> Please write back here and/or review the spec.
>> Thanks!
>> Anne
>>
>> On Thu, Jul 21, 2016 at 8:09 PM, Kato, Tomoyuki
>> <kato.tomoyuki at jp.fujitsu.com> wrote:
>>>> Hi all,
>>>>
>>>> I'll say it's not as bad as I originally thought. I wrote up the spec here:
>>>>
>>>> https://review.openstack.org/345639
>>>>
>>>> These guides are affected:
>>>> admin-guide
>>>> cli-reference (glance_property_keys.rst is the only file)
>>>> ops-guide
>>>> user-guide
>>>>
>>>> source/common/
>>>>
>>>> I have a couple of questions on the review:
>>>>
>>>> Do we want this set of changes for newton? Only the cli-reference is
>>>> "versioned" currently.
>>>> How are the <guide-name>/source/common/ files sourced? (Hoping those
>>>> are a change once get many proposition.)
>>>>
>>>> Thanks,
>>>> Anne
>>>
>>> CLI Reference is not versioned.
>>> Since glance_property_keys.rst is a included file at now,
>>> however, I'd like to change it for Newton.
>>>
>>> Also, my +1 to change all guides for consistency.
>>>
>>> Thanks,
>>> KATO Tomoyuki
>>> _______________________________________________
>>> OpenStack-docs mailing list
>>> OpenStack-docs at lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>>
>>
>> --
>> Anne Gentle
>> www.justwriteclick.com
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



-- 
Anne Gentle
www.justwriteclick.com



More information about the OpenStack-docs mailing list