document QubesDB+systemd provisioning pattern

Open
#166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reading freedomofpress/securedrop-workstation#1004 to understand the VM-specific service pattern referenced by the issue. Then identify the appropriate developer-documentation location and decide whether a written explanation, a minimal example, or both are needed; done means a new Workstation developer can reproduce the QubesDB and systemd provisioning pattern without reinventing it.

Written by the indexing model from the issue text.

Description

Describe the change

Now that we have a pattern we like for configuring VM-specific services (freedomofpress/securedrop-workstation#1004), we should document it and/or provide a minimal example so that it's easily replicable.

How will this impact users?

As a Workstation developer, I don't want to reinvent the wheel.

As a new Workstation developer, I want an abstract example of what a wheel is, since that's a pattern I haven't seen in any other system I've worked on.

Dominant language
Python
Stars
6
Forks
4
Avg merge
2h 22m
Merged PRs (30d)
1

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.

More from freedomofpress/securedrop-dev-docs

All issues in freedomofpress/securedrop-dev-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.