[DOCS] Review Security Docs - Security WG
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
Security documentation is fragmented, difficult to use and out of date.
We've agreed within the Security Working Group to undertake a review to:
- Find and document the location of existing security related docs
- Assess those docs to see if they should be updated/removed/consolidated
- Make the required changes
- Co-ordinate with the Docs WG to work out the best location for those docs and how to make them more easily discoverable
Suggested Fix
- Find existing docs and document their location this issue
- Review them
- Decide on required action for each doc
Additional context
- Running the Salt Master/Minon as an Unprivileged user - not updated for 3006.0 (or for some time before that)
- Hardening Salt - lots of info, not all of it good, written in a difficult to follow and not easily actionable way
- Salt User Guide - Security page - more up to date, but repeats qute a bit of info from the hardening guide without much detail or actionable info
- Security docs issues:
- #62820
- #57158
- #62144
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 by inventorying the security documentation linked in the issue, including nonroot.html, hardening.html, and the Salt User Guide security page, then read issues #62820, #57158, and #62144. Done means documenting each location, assessing whether it should be updated, removed, or consolidated, and recording the required actions and proposed organization with the Docs WG.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100