Issue #6914 has been updated by Nick Fagerlund.

Status changed from Accepted to Investigating

Hmm. In terms of what it does to the table of contents, this is less than 
straightforward: 

* I don't want the TOC to look insane and broken. ("2. 1. Terminology.")
* I don't want the mechanical TOC generator to be a limiting factor on what we 
can write. 

Furthermore, I'm not currently convinced that we've already found the best 
order for the document; if we start referring to sections by ordinal number 
instead of name, we're basically locking ourselves into the current document 
structure. 

Further furthermore, I don't quite see the benefit of being able to say numbers 
instead of words. Can you convince me on that one?

So, yeah. I don't want to merge this without thinking about it further. 
----------------------------------------
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: 
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.

Reply via email to