Issue #6914 has been updated by Garrett Honeycutt. Keywords set to style rfc numbering
Definitely understand that having numbers and a table of contents (TOC) complicates updating the document. While more complicated, it does not lock us into the current format. The need for the numbered sections, as shown in the branch, is based around the need to quote specific sections of the style guide. This is what RFC documents do and it is extremely useful. See RFC 2821 as an example - http://tools.ietf.org/html/rfc2821. While updating the training slides, I found that I needed the ability to reference specific sections and even specific Should's and Must's. This is going to continue, especially as we do audits, so PS can reference specific items in the guide. ---------------------------------------- Bug #6914: entries in style guide needs to be numbered https://projects.puppetlabs.com/issues/6914 Author: Garrett Honeycutt Status: Investigating Priority: Normal Assignee: Nick Fagerlund Category: Target version: Keywords: style rfc numbering Branch: https://github.com/puppetlabs/puppet-docs/tree/tickets/6914 Affected URL: We need to add numbers to the sections of the style guide. This change will not change the actual rules of the style guide and show not result in another style guide version. Reasoning is that you can say that you are in or out of compliance with section 1.2.3 of the style guide. This is already coming up as I am bringing our training into compliance. -- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://projects.puppetlabs.com/my/account -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
