freedomofpress / freedomofpress/securedrop-dev-docs
Move advanced topics of shared concern to "Advanced Topics" section
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 1
Description
The SecureDrop development ecosystem keeps growing in complexity and will continue to do so for a while until it contracts again:
- Packaging of
securedrop-adminfor Qubes & Tails (in progress) - Electron App rewrite of SecureDrop Client
- SecureDrop Protocol based PoCs and eventually full implementation
- Dveloper tooling across repos / projects / components
The "Getting Started / SD Server / SD Workstation" distinction doesn't quite cut it anymore. For starters, I would suggest adding an "Advanced Topics" section which could include things like Dependency Update Policies, feature specs that span implementations, and other sections that don't quite fit under any of the existing chapters.
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 locating the existing “Getting Started”, “SD Server”, and “SD Workstation” sections in the developer documentation. Review how cross-cutting topics such as dependency update policies, feature specifications, and developer tooling are currently organized; done means adding an “Advanced Topics” section with the agreed material.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- electron
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100