SecureDrop Demo and Localization Onboarding
MAKING WHISTLEBLOWING ACCESSIBLE WORLDWIDE
Before Translating...
The community of contributors to the SecureDrop project is diverse and it is important to the SecureDrop and Freedom of the Press Foundation teams that both staff and volunteers are able to work and collaborate in a safe environment. The code of conduct applies to physical and virtual spaces hosted by the Freedom of the Press Foundation team.
Please read the full Code of Conduct to learn what is considered appropriate behavior in the community and how the CoC is enforced.
Resources:
Code of Conduct: https://github.com/freedomofpress/.github/blob/main/CODE_OF_CONDUCT.md
2. Review the SecureDrop Translation
Documentation
The SecureDrop translation documentation will walk you through how to create a Weblate account, the basics of contributing to translation and review on Weblate and several tips and tricks. It’s a great resources to have ready as you create your account and start translating.
Resources:
Translating SecureDrop Docs: https://docs.securedrop.org/en/latest/development/translations.html
3. Review the SecureDrop Glossary
The SecureDrop Glossary hosted in the SecureDrop documentation overviews the key and recurring terminology used across the platform. These terms are important to recognize and understand prior to translation.
This glossary is separate from the glossary hosted in Weblate, where you can add translations in addition to the sources text.
Resources:
Glossary: https://docs.securedrop.org/en/stable/glossary.html
4. Demo SecureDrop
Demo the platform! It can be challenging to understand how text is used without viewing it within the context of the software. Having a general understanding of what the platform looks like will help you as you begin to translate. You can also view the demo with the most recent release’s translations, making it easier to review and cross-check translations.
Resources:
5. Review the Translation and Review Guidelines
Localization Lab’s Translation and Review Guidelines will give you a good overview what what you should and shouldn’t do as a contributor as well as provide tips for how to manage more challenging elements of software localization. Some of the guidelines are geared toward a different translation platform (Transifex), however the concepts still apply to Weblate.
Resources:
Translation and Review Guidelines: https://wiki.localizationlab.org/index.php/Translation_and_Review_Guidelines#Communicate
Getting Started...
1. Create a Weblate Account
Resources:
Weblate Documentation: https://docs.weblate.org/en/weblate-4.3.2/user/translating.html
Translating SecureDrop Docs: https://docs.securedrop.org/en/latest/development/translations.html#get-started-using-weblate
While Translating...
1. Focus on Accuracy
Source Information: Always take a look at the Source Information panel to see if the developers provided screenshots or specific notes about how to translate the string. The Source Information will also contain information about where the string appears in the SecureDrop code which may help you better understand how the text should be translated. SecureDrop also uses Labels which let you know added information about a string, like if it is alt text or should not be translated.
Translation Checks: Pay attention to translation checks. These will be highlighted on the language dashboard with quick links to access and address them. You will also find them highlighted in red within the translation editor. These checks will let you know if you have forgotten punctuation, added double spaces or have mistreated placeholders and variables for example.
SecureDrop Demo: We recommend having the demo open and ready to reference just in case you have any questions about how a term is used. English is notoriously tricky to translate from because it can be challenging to determine the part of speech of a word without context:
Example: Copy <- Is this a verb in the imperative or infinitive? Or is it a noun?
2. Focus on Consistency
Glossary: The glossary will help you and other contributors use consistent terminology. Consistency is key to ensure users use the platform correctly. Imagine if the term Source or passphrase were translated differently across the platform?
Please contribute to the glossary when you can, particularly with translations of the terms in the SecureDrop Glossary: https://docs.securedrop.org/en/stable/glossary.html
Translation Memory: Use the Translation Memory in Weblate to cross reference how similar terms and phrases are already translated across the project.
References to other tools: Make sure translations of features in other tools are consistent with those tools. For example, a Tor Browser reference should be consistent with the current Tor Browser translation.
Search: You can also use the Weblate search to filter strings by many different criteria.
Weblate
The Localization Lab Mailing List & Mattermost
3. Communicate
The SecureDrop Forum & Gitter
Leave comments on strings that you have questions about. Mention other contributors and Localization Lab or SecureDrop staff using ‘@username’ in the comment.
Join the Mailing List: email info@localizationlab.org
Request to join Mattermost: email info@localizationlab.org
Keeping SecureDrop Localized...
1. SecureDrop Localization Schedule
SecureDrop will have a new release roughly every 6 - 8 weeks, which means content will need localization.
Feature Freeze: After this point, no new features will be added to SecureDrop.
Feedback Period: This period will generally last about 3 - 4 days. You can review new English sources content added to the project and leave comments on strings that need changes to the source text or need more clarification or context.
String Freeze: After this point, the English source text will not change.
Translation and Review Period: This period will generally last 1.5 - 2 weeks, in which time 100% of content must be translated and reviewed in order for SecureDrop to be re-released in a given target language.
Release: The SecureDrop release will generally happen 1 - 2 days after the translation and review deadline.
Resources:
https://forum.securedrop.org/t/about-the-translations-category/16
2. SecureDrop Minimum Translation & Review Thresholds
To ensure that the platform remains safe to use for individuals who do not speak English:
This is why it’s so important that the SecureDrop localization team grow and that contributors return to support localization with each release.
3. SecureDrop Project Notifications
Announcements: You will receive email notifications when an announcement is made to the SecureDrop project. With each release, an announcement will be made to overview the localization and feedback timeline and deadlines.
More Notifications: You can turn on notifications in your Weblate preferences so that you receive email notifications when updates are made to the source strings (new content is added) and so that you receive notifications when individuals change your translations.
Additional SecureDrop Localization Resources
Localization Lab Wiki: https://wiki.localizationlab.org/index.php/SecureDrop
Localization Lab SecureDrop AMA: https://www.localizationlab.org/blog/2018/4/20/4bp1j2olispup45z8o2mm5nb5snxm2