saltstack / saltstack/salt

[DOCS] Review Security Docs - Security WG

Open
#64,289 2 comments 1 reaction 0 assignees View on GitHub

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.