<div dir="ltr">Then it makes sense. Thanks for clarification, Anne! I can also help with the changes.<div><br></div><div>Best</div><div>Olena</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jul 19, 2016 at 4:05 PM, Anne Gentle <span dir="ltr"><<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="auto"><div>Sorry, I have to over rule. The hyphen convention is for search optimization and find ability. [2]</div><div><br></div><div>I hear your consistency desire to match Python, but our outcome and overall goals are to write docs that are readable and findable. Let's say each document file is a package-like entity rather than a module. :)<br><br><div>Thanks,<div>Anne</div><div><br></div><div>2. <a href="https://support.google.com/webmasters/answer/76329?hl=en" target="_blank">https://support.google.com/webmasters/answer/76329?hl=en</a><br><div><br></div></div></div></div><div><div class="h5"><div><br>On Jul 19, 2016, at 12:59 AM, Olena Logvinova <<a href="mailto:ologvinova@mirantis.com" target="_blank">ologvinova@mirantis.com</a>> wrote:<br><br></div><blockquote type="cite"><div><p dir="ltr">+1 for changing the convention to underscore instead of hyphen.</p>
<p dir="ltr"> As far as I am concerned, visually it's easier to read and distinguish words in a filename with underscore, bc underscore has a bigger length than hyphen.</p>
<p dir="ltr">Thanks<br>
Olena</p>
<div class="gmail_extra"><br><div class="gmail_quote">19 июля 2016 г. 8:43 AM пользователь "Akihiro Motoki" <<a href="mailto:amotoki@gmail.com" target="_blank">amotoki@gmail.com</a>> написал:<br type="attribution"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex">I don't know the background of the current convention.<br>
Is there any reason we prefer to hyphens over underscores?<br>
<br>
In Python we need to use underscores for such cases.<br>
I think most developers familiar with python tend to use underscore as<br>
delimiters.<br>
IMHO it is better to use same convention on file naming in python and docs.<br>
<br>
I hit some differences between openstack-manuals and python (or project devref),<br>
for example, RST title conventions, file naming.<br>
<br>
Akihiro<br>
<br>
2016-07-19 5:30 GMT+09:00 Anne Gentle <<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>>:<br>
> I kept trying to put this off, but... I think I'll dive right in.<br>
><br>
> I see we have style guidance to use hyphens for file names [1], but in<br>
> the repo, there are still RST files with underscores in the names. I'm<br>
> sure it's due to the original xml:id having underscores.<br>
><br>
> I can take on the task of renaming, and I'd like to write a spec to<br>
> make sure I don't miss anything: Cross reference links? Redirects?<br>
> Tackle the work a guide at a time? Finding other contributors who hate<br>
> inconsistency? Timing with the release? Making sure we really want<br>
> this? :)<br>
><br>
> Does a spec sound good? Or can you convince me this change isn't worth<br>
> the effort?<br>
><br>
> Thanks,<br>
> Anne<br>
><br>
> 1. <a href="http://docs.openstack.org/contributor-guide/docs-structure.html#file-naming-conventions" rel="noreferrer" target="_blank">http://docs.openstack.org/contributor-guide/docs-structure.html#file-naming-conventions</a><br>
> --<br>
> Anne Gentle<br>
> <a href="http://www.justwriteclick.com" rel="noreferrer" target="_blank">www.justwriteclick.com</a><br>
><br>
> _______________________________________________<br>
> OpenStack-docs mailing list<br>
> <a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</blockquote></div></div>
</div></blockquote></div></div></div></div>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div>Best regards,</div>Olena Logvinova,<div>Technical Writer | Mirantis, Kharkiv | 38, Lenin av., Kharkiv</div><div><a href="mailto:ologvinova@mirantis.com" style="color:rgb(17,85,204)" target="_blank">ologvinova@mirantis.com</a> | <a href="tel:%2B380950903196" value="+380669377102" style="color:rgb(17,85,204)" target="_blank">+380950903196</a></div></div></div>
</div>