search

hlindberg / misc-puppet-docs

Misc Puppet Related Docs
8 stars 6 forks source link

Need to focus and unclutter #4

Open nibalizer opened 11 years ago

nibalizer commented 11 years ago

https://github.com/hlindberg/misc-puppet-docs/blame/master/data-in-modules.md#L549-L603

This passage started out so strong with the breakdown of the first component of the triplet. But as a reader I am immediately confused because the section on the second element leads off with a discussion of the third element. I would recommend you take the discussion on the third element and put it second, yes this is somewhat confusing but the reader will just roll with it since the first and third elements are easier to understand.

Also on L558 'actual' is probably meant to be 'actually'

hlindberg commented 11 years ago

Thanks, at the point where it started to become unfocused and cluttered it became evident that it would be better to document the simplified solution that is about to be available, and then explain the difference between that and the current - i.e. "sorry, but there is lots of redundancy in the original format". The use of the "three values" actually just makes it hard to explain how it really works.