[Openstack-docs] Conventions for filenames and chapter/section IDs

Steve Gordon sgordon at redhat.com
Sun May 25 21:50:41 UTC 2014


----- Original Message -----
> From: "Anne Gentle" <anne at openstack.org>
> To: "Andreas Jaeger" <aj at suse.com>
>
> Something to think about for ch and sec is that we won't always author in a
> book-like manner, so let's not lock ourselves into that sort of thinking
> due to current file names.
>
> Stick to the install guide for now, to apply conventions, just please don't
> use something as meaningful semantically as chapter and section.

I actually think it's important/useful information in the filename. It reflects the root node of the file's XML which has an impact on where you can nest/include it in another document (you can't include a chapter in a section for example, but you can include a section in a chapter). It's got more to do with the realities of the format being used than whether we're thinking in terms of books, articles, etc.

Granted if we moved to a non-XML format this would no longer be the case, but I think we'd have bigger conversion issues than bulk renaming the files/links. ;)

-Steve



More information about the Openstack-docs mailing list