[OpenStack-docs] hyphens for file names

Lana Brindley openstack at lanabrindley.com
Mon Jul 18 23:24:03 UTC 2016


Yeah, I think a spec is a good idea. Might be worth roping in the speciality teams for each guide, though?

L

On 19/07/16 06:30, Anne Gentle wrote:
> 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
> 

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160719/71c56939/attachment-0001.pgp>


More information about the OpenStack-docs mailing list