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

diagram installation, configuration, update, and backup flows #73

Open
cfm opened this issue Jun 6, 2023 · 0 comments
Open

diagram installation, configuration, update, and backup flows #73

cfm opened this issue Jun 6, 2023 · 0 comments

Comments

@cfm
Copy link
Member

cfm commented Jun 6, 2023

Describe the change

Because our various provisioning flows (a) are unusually complicated and (b) differ subtly from one another, we should diagram them precisely.

How will this impact users?

As a contributor, I'd like to understand the different workflows I may encounter in different environments, so that I can execute and troubleshoot them more effectively.

As a maintainer, I'd like to have a high-level view of the different workflows, so that I can reason about them and any changes we may make to them.

User Research Evidence

In freedomofpress/securedrop#6826 (comment), @nathandyer and I used the following sequence diagram to illustrate the flow of values and artifacts in a securedrop-admin install run:

Additional context

#8 proposes something similar at the repository level, which I imagine would include a graph (in "space"). This should be a set of task-specific sequence diagrams (in time).

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

1 participant