3 ms·
It's gotten better, but it still is very messy. What it needs above everything else is a table contents that stays with you as you read. The documentation you
by lobster_johnson 15y ago
It's gotten better, but it still is very messy.
What it needs above everything else is a table contents that stays with you as you read. The documentation you have now only lists a TOC for the section you're in. And the TOC is tucked away in the right-hand corner and stays there when you scroll. So whenever I dive into your docs, I never get a sense of "where" I am in the whole big ball of string, and I get frustrated.
The first page is weirdly arranged. For example, it's got a big headline "Learning Puppet", then "Learn to use Puppet! New users: start here." Then there is a link to "Introduction and Index". I interpret this as being the link to the "new users" guide, and that the next two sections ("Part one", "Part two") are not related. But if you click on "Introduction and Index" you come to a new page which lists the exact same TOC, and has no section named "Introducion". It's confusing.
The "reference manual" and "guides" sections are similarly confusing because of the lack of a unified table of contents. The reference is particularly bad because I want to look up something alphabetically ("I want to manage users, so I bet it's called 'user'"), but the reference is arranged by topic.
- nigelk 15y agoThose are all good points, and we know the layout needs to improve. I would add though that once you've gone through the basics, you find yourself primarily living in the Type Reference, which is arranged alphabetically. http://docs.puppetlabs.com/references/stable/type.html http://docs.puppetlabs.com/references/stable/type.html Always happy to get bug reports, feature requests and feedback on the docs... http://projects.puppetlabs.com/projects/puppet-docs http://projects.puppetlabs.com/projects/puppet-docs
- lobster_johnson 15y ago> I would add though that once you've gone through the basics, you find yourself primarily living in the Type Reference Yes, that's were I ended up. I'm way beyond that level now, but I sometimes have to look something up in the docs, and always have to hunt down the URL to that particularly page.