New use_superseded option needs added to configuration documentation
Open
Nobody has claimed this yet.
Confirmed
doc-request
documentation
severity-medium
time-estimate-sprint
ZD
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue/Question
The use_superseded option is not mentioned in either the master config documentation or the minion config documentation.
Specifically, this documentation only mentions to adding this option to the minion configuration inferring that is the only place it is needed.
Versions Report
2018.3.3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the master and minion configuration documentation linked in the issue, and search both pages for use_superseded and the existing guidance about adding it to minion configuration. Update the relevant documentation so the option is described in each configuration context, then verify both rendered pages mention it accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100