freedomofpress / freedomofpress/securedrop-dev-docs

consolidate sections on translation, internationalization, and release management

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

Nobody has claimed this yet.

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

Description

Beyond the scope of #86, I think we can consolidate and streamline the documentation of:

  1. how the SecureDrop Server and Client are internationalized;
  2. how translators translate and review their strings; and
  3. how maintainers manage their releases.

The pre-#86 documentation was highly specific on mechanics, of which there are fewer now. The priority now should be to create consistent expectations for each of these roles and processes across applications.

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.

Research direction

Review the existing documentation for how the SecureDrop Server and Client are internationalized, how translators translate and review strings, and how maintainers manage releases. Done means consolidating these topics into consistent expectations for the relevant roles and processes across both applications.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, internationalization, localization, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.