freedomofpress / freedomofpress/securedrop-dev

Consolidate test plans on `securedrop` wiki; phase out other GitHub wikis

Open
#30 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We have three GitHub wikis:
https://github.com/freedomofpress/securedrop/wiki
https://github.com/freedomofpress/securedrop-client/wiki
https://github.com/freedomofpress/securedrop-workstation/wiki

They're mainly used for updating test plans. Historically, they were more active to store meeting notes and architecture docs, but these days, such documents mainly live in:

  • The dev docs
  • GitHub issues
  • Discussions (also centralized on securedrop)
  • FPF's internal wiki
  • Assorted GDocs

I would propose:

  • Move test plans to securedrop wiki
  • Review other materials for freshness; preserve useful other docs in https://developers.securedrop.org/ or securedrop wiki
  • Close securedrop-workstation and securedrop-client wikis

This is to reduce the number of places we have to look for things, or that we consider when creating new docs; generally, the dev docs seem like the best place for tips & architecture documentation.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the three linked GitHub wikis and the developer documentation at developers.securedrop.org to inventory test plans and other materials. Identify useful documents that need preservation or relocation, then verify that test plans are consolidated on the securedrop wiki and that the securedrop-workstation and securedrop-client wikis can be closed.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.