Open Stack

I don't know the background of the current convention.
Is there any reason we prefer to hyphens over underscores?

In Python we need to use underscores for such cases.
I think most developers familiar with python tend to use underscore as
delimiters.
IMHO it is better to use same convention on file naming in python and docs.

I hit some differences between openstack-manuals and python (or project devref),
for example, RST title conventions, file naming.

Akihiro

2016-07-19 5:30 GMT+09:00 Anne Gentle <annegentle at justwriteclick.com>:
> I kept trying to put this off, but... I think I'll dive right in.
>
> I see we have style guidance to use hyphens for file names [1], but in
> the repo, there are still RST files with underscores in the names. I'm
> sure it's due to the original xml:id having underscores.
>
> I can take on the task of renaming, and I'd like to write a spec to
> make sure I don't miss anything: Cross reference links? Redirects?
> Tackle the work a guide at a time? Finding other contributors who hate
> inconsistency? Timing with the release? Making sure we really want
> this? :)
>
> Does a spec sound good? Or can you convince me this change isn't worth
> the effort?
>
> Thanks,
> Anne
>
> 1. http://docs.openstack.org/contributor-guide/docs-structure.html#file-naming-conventions
> --
> 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