Settings

Theme

SaltStack's docs set the standard for software documentation

docs.saltstack.com

8 points by m1crofarmer 12 years ago · 8 comments

Reader

pgl 12 years ago

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.

iurisilvio 12 years ago

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).

Shish2k 12 years ago

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

mathrawka 12 years ago

Comprehensive? Yes

Easy to find what you are looking for? Not really

dumaspere 12 years ago

No, not especially. Poor search, pages in apparently random order. Quantity is good though.

shakiba 12 years ago

Why?

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection