Re: [Openstack] Docs: Would like to introduce indexing. How ?
On Tue, Feb 28, 2012 at 4:46 AM, Anne Gentle a...@openstack.org wrote: It's not a dislike - rather it fulfills a need for reuse of content so that sections are not rigidly numbered for certain types of deliverables, such as the admin guides. reuse is OK. I speak about dynamically-generated indexes, by the PDF / HTML compilers. So only final docs will have them, not XML src code. -- -Alexey Eromenko Technologov ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
[Openstack] Docs: Would like to introduce indexing. How ?
As the OpenStack documentation becomes increasingly complex, I would like to introduce indexing there. Currently only major chapters have indeces, while *all* sub-chapters do not. Lack of indexing makes it difficult to open specific bugs, and difficult to share specific configuration settings on IRC. Currently it looks like: (tested both HTML and PDF versions) Chapter 7. Networking Configuring Networking on the Compute Node- Configuring Flat DHCP Networking OpenStack docs should look like: Chapter 7. Networking 7.3. Configuring Networking on the Compute Node- 7.3.2 Configuring Flat DHCP Networking How-to patch the docs to introduce multi-level indexing ? -- -Alexey Eromenko Technologov ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
Re: [Openstack] Docs: Would like to introduce indexing. How ?
It's not a dislike - rather it fulfills a need for reuse of content so that sections are not rigidly numbered for certain types of deliverables, such as the admin guides. The requirement for a unique identifier is filled by having unique IDs for each section that then create an HTML page. Please copy and paste URLs when you need to discuss a section in IRC or when logging bugs. For API reference guides auto-numbering meets a need for a section reference. I believe the use case is correct for each type of document. I'd be happy to talk with you on IRC tomorrow to discuss our doc toolchain and some style decisions that have been made on the way as well as the mechanics. I'm typically online from 8-5 GMT-6. Anne On Mon, Feb 27, 2012 at 4:59 PM, Alexey Eromenko al4...@gmail.com wrote: On Tue, Feb 28, 2012 at 12:55 AM, Anne Gentle annegen...@justwriteclick.com wrote: Yes it is a flag in the build file, pom.xml. Based on prior discussion I have chosen not to use autonumber for admin guide output. The settings are a postscript in my prior email. Is there a specific reason to dislike auto-numbers indexing ? For me, the big reason to *like* auto-numbers, is that it makes it easy to share config steps on IRC. -- -Alexey Eromenko Technologov ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp ___ Mailing list: https://launchpad.net/~openstack Post to : openstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
