Task #3238
closed
Update Salt documentation
Added by Brett Cornwall over 4 years ago.
Updated over 2 years ago.
Description
'There are lots of README.rst files throughout the repo.
- Determine the policy of module documentation: Revisit doc/guideline.rst to see if any policies need revising.
- Review if Python's .rst format/Makefile/sphinx is the desired format to use or if markdown would be preferred these days
- Comb through each module and update
Many of the README.rst files are just stating the obvious (e.g. "The apt module configures apt-related settings") and can be removed.
Brett Cornwall wrote:
- Review if Python's .rst format/Makefile/sphinx is the desired format to use or if markdown would be preferred these days
guilhem, what are your thoughts on format?
guilhem, what are your thoughts on format?
No hard feeling but my preference would to use markdown, especially since both gerrit and GitLab can render it natively (no need for an external processor). Would prefer a grep-able source format in any case, be it .rst, .md, or something else.
- Assignee set to Brett Cornwall
- Tags Documentation added
- Status changed from New to In Progress
- Status changed from In Progress to Resolved
- % Done changed from 0 to 100
- Status changed from Resolved to Closed
Also available in: Atom
PDF