Project

General

Profile

Task #3238

Update Salt documentation

Added by Brett Cornwall 7 months ago. Updated 7 months ago.

Status:
In Progress
Priority:
Normal
Category:
-
Target version:
-
Start date:
Due date:
% Done:

0%

Tags:
Documentation, Salt
URL:

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.

History

#1

Updated by Brett Cornwall 7 months ago

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?

#2

Updated by Guilhem Moulin 7 months ago

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.

#3

Updated by Brett Cornwall 7 months ago

  • Assignee set to Brett Cornwall
  • Tags Documentation added
#4

Updated by Brett Cornwall 7 months ago

  • Status changed from New to In Progress

Also available in: Atom PDF