Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer docs for unattended-upgrades #11

Open
eloquence opened this issue Mar 9, 2021 · 2 comments
Open

Add developer docs for unattended-upgrades #11

eloquence opened this issue Mar 9, 2021 · 2 comments

Comments

@eloquence
Copy link
Member

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.

@eloquence
Copy link
Member Author

(Note: I have no strong opinion on putting this documentation on the wiki vs. RTD - if anything I personally favor the wiki for developer docs - but I would suggest that we discuss that a bit more as we pick up issues like this one.)

@zenmonkeykstop
Copy link
Contributor

I think there's a case for having this in the admin docs, if only to make troubleshooting more effective (as mentioned in ticket, by saying how the system should behave).

@eloquence eloquence transferred this issue from freedomofpress/securedrop-docs Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants