Task #3238: Update Salt documentation - Infrastructure - The Document Foundation Redmine

Actions

Copy link

Task #3238

closed

Update Salt documentation

Added by Brett Cornwall over 4 years ago. Updated over 2 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Brett Cornwall

Category:

Target version:

Start date:

Due date:

% Done:

100%

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.

Actions

Copy link

Updated by Brett Cornwall over 4 years 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?

Actions

Copy link

Updated by Guilhem Moulin over 4 years 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.

Actions

Copy link