[OpenStack-docs] hyphens for file names

Olena Logvinova ologvinova at mirantis.com
Wed Aug 10 08:56:56 UTC 2016


As long as these cross-refs do not influence the search optimization, I
would not touch these for now. Or do they?

Anyways, I didn't change these in my patch [1] either.

 [1] https://review.openstack.org/#/c/353043

On Thu, Aug 4, 2016 at 9:51 PM, Akihiro Motoki <amotoki at gmail.com> wrote:

> 2016-08-04 11:35 GMT+09:00 Anne Gentle <annegentle at justwriteclick.com>:
> > Thanks for this! I'm updating it as I test with the admin-guide. Yep, you
> > need to be in the /source/ directory for non-common files as that's where
> > the RST files are.
> >
> > One new question I have. Should I not update the inserted cross reference
> > markers at the tops of sections, such as ..
> > _shared_file_systems_share_types: even though the file name is now
> > shared-file-systems-share-types?
>
> This is a gray zone. When I worked on 'common' document, I did not
> touch cross references, but I am okay with either decision.
>
> BTW, manila-related documents in the admin guide have cross references
> like ".. _shared_file_systems_share_types:" but it seems they are not
> used anywhere. Looks unnecessary.
>
> Akihiro
>
> >
> > Thanks,
> > Anne
> >
> > On Tue, Aug 2, 2016 at 11:06 PM, Akihiro Motoki <amotoki at gmail.com>
> wrote:
> >>
> >> I shared my log to a etherpad page when I worked on 'common' file
> >> renaming.
> >> It may help you work on other guides.
> >>
> >> https://etherpad.openstack.org/p/docs-file-renaming
> >>
> >> 2016-08-02 22:11 GMT+09:00 Anne Gentle <annegentle at justwriteclick.com>:
> >> > No problem.
> >> >
> >> >
> >> > https://blueprints.launchpad.net/openstack-manuals/+spec/
> consistency-file-rename
> >> >
> >> > On Mon, Aug 1, 2016 at 6:26 PM, Lana Brindley
> >> > <openstack at lanabrindley.com>
> >> > wrote:
> >> >>
> >> >> Hi Anne,
> >> >>
> >> >> Sorry to be a pain, but can I please get a blueprint off you too?
> It'll
> >> >> make it easier to track relevant reviews, I think.
> >> >>
> >> >> L
> >> >>
> >> >> On 30/07/16 13:53, Anne Gentle wrote:
> >> >> > Thanks all!
> >> >> >
> >> >> > Spec is now updated with further clarity on tasks and assignees.
> >> >> >
> >> >> > Anne
> >> >> >
> >> >> > On Fri, Jul 29, 2016 at 5:43 PM, Mariia Zlatkova
> >> >> > <mzlatkova at mirantis.com> wrote:
> >> >> >> Hi all,
> >> >> >>
> >> >> >> I can pick up the user guide.
> >> >> >>
> >> >> >> Thanks,
> >> >> >> Maria
> >> >> >>
> >> >> >> 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
> >> >> >
> >> >> >
> >> >> >
> >> >>
> >> >> --
> >> >> Lana Brindley
> >> >> Technical Writer
> >> >> Rackspace Cloud Builders Australia
> >> >> http://lanabrindley.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
> >> >
> >> > _______________________________________________
> >> > OpenStack-docs mailing list
> >> > OpenStack-docs at lists.openstack.org
> >> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> >> >
> >>
> >> _______________________________________________
> >> 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
>



-- 
Best regards,
Olena Logvinova,
Technical Writer | Mirantis, Kharkiv | 38, Nauki av., Kharkiv
ologvinova at mirantis.com | +380950903196
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160810/75e19cd7/attachment-0001.html>


More information about the OpenStack-docs mailing list