freedomofpress / freedomofpress/securedrop-dev-docs
Add developer docs for unattended-upgrades
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
Assuming we move forward with shipping unattended-upgrades with 1.8.0, we should add some developer documentation similar to what we have done with other components (e.g., securedrop-admin), given the complexity of interactions between various flags, timers, and configuration options.
This documentation ideally should well-specify the expected behavior -- when are package index updates expected to happen, when are package downloads expected to happen, when are reboots expected to happen, what happens if package updates trigger interactive prompts, etc. -- and includes important notes for testing/QA.
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 reviewing the existing developer documentation for components such as securedrop-admin, then investigate the intended unattended-upgrades behavior and its flags, timers, and configuration options. Document when index updates, downloads, and reboots occur, how interactive prompts are handled, and include the relevant testing and QA notes; no target file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100