News for hackers. Stuff that matters.
Re:SaltStack's docs set the standard for software documentation by pgl on Wednesday May 14, 2014 @05:41AM (#7742921)
No, no they don't.

Poor search (custom Google searches are substandard generally), hidden full index, table of contents that doesn't match the index page, no synposes on pages that need them (eg CLI reference), no indication of what came before or next for individual sections, hidden index link, etc.

However, that's all very critical. On the plus side, comprehensive documentation is far better than no documentation at all, or poor / lacking documentation. And when you do want to read long sections of text, it looks quite well written.

Re:SaltStack's docs set the standard for software documentation by rglauser on Wednesday May 14, 2014 @10:54AM (#7744085)
We have a Salt Docs Sprint coming up next week. Details here: http://www.saltstack.com/saltstack-events/salt-docs-sprint Please add this feedback as an issue on our GitHub tagged with ticket #12446, and please join the sprint and contribute if you can.
Re:SaltStack's docs set the standard for software documentation by iurisilvio on Wednesday May 14, 2014 @05:58AM (#7742957)
The getting started doesn't help to really start anything.

I had to use third party docs to start with salt and ansible. I don't like puppet and chef docs either. Maybe all of them expect some user knowledge (I'm a developer learning about configuration management).

Re:SaltStack's docs set the standard for software documentation by Shish2k on Wednesday May 14, 2014 @05:48AM (#7742934)
As a frequent user of salt's docs I am quite impressed, but still more impressed by postgres :P --> http://www.postgresql.org/docs/9.3/static/index.html
Re:SaltStack's docs set the standard for software documentation by mathrawka on Wednesday May 14, 2014 @05:05AM (#7742830)
Comprehensive? Yes

Easy to find what you are looking for? Not really

Re:SaltStack's docs set the standard for software documentation by dumaspere on Wednesday May 14, 2014 @07:17AM (#7743097)
No, not especially. Poor search, pages in apparently random order. Quantity is good though.
Re:SaltStack's docs set the standard for software documentation by shakiba on Wednesday May 14, 2014 @05:17AM (#7742867)
Why?