Docs updates around securing salt
Open
Nobody has claimed this yet.
documentation
security and optimization
severity-medium
time-estimate-long-term
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
We've had instructions on hardening salt for a while, see https://docs.saltstack.com/en/2016.3/topics/hardening.html#general-hardening-tips
We should make it more obvious which "tips" should be done instead of just a tip.
It should be very obvious what a person should not do.
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 General Hardening Tips page at docs.saltstack.com/en/2016.3/topics/hardening.html. Review the existing guidance and identify which items are required practices versus optional tips, including what users should not do. Done means the security instructions clearly distinguish recommended actions from prohibited ones.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100