Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mention of demo server in translation docs #197

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion docs/development/translations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,10 @@ How to translate a phrase on Weblate
#. :ref:`Select a language <how_to_translate_a_language_weblate>`.
#. Read the translatable string in the text area labelled **Source**.
#. Review the suggested translations if there are any in the **Glossary** sidebar.
#. Review the contextual information about the :ref:`source string <weblate_glossary_source_string>` in the **Source information** sidebar, like its location in our source code.
#. Review the contextual information about the :ref:`source string <weblate_glossary_source_string>`
in the **Source information** sidebar, like its location in our source code.
#. If a screenshot of the SecureDrop user interface is available, read the *source string* in context.
You can also use `SecureDrop's demo server`_ to preview the source string in context.
#. Input your translation in the **Translation** test area near the *source string*.
#. Click **Save**. The next untranslated string will appear automatically.

Expand All @@ -203,6 +205,7 @@ How to translate a phrase on Weblate
- :ref:`Learn more about translating phrases with placeholders <how_to_translate_a_phrase_with_placeholders>`
- :ref:`Learn more about translating phrases with HTML code <how_to_translate_a_phrase_with_html_code>`
- :ref:`Learn more about using language glossaries on Weblate <how_to_use_language_glossaries_on_weblate>`
- :ref:`Learn more about using SecureDrop's demo server <how_to_use_securedrop_demo_server>`

.. _how_to_change_an_existing_translation:

Expand Down Expand Up @@ -334,6 +337,36 @@ Self-Defense glossary`_, but the glossary sidebar says ``No related strings foun
we'd really appreciate it if you could add those terms to
the glossary of the language you're working with.

.. _how_to_use_securedrop_demo_server:

How to use SecureDrop's demo server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The demo server always showcases the latest release candidate of SecureDrop.

Unlike a real SecureDrop instance, you can access the demo server using any
web browser.

You can use it to review new *source strings* in the context in which either
a *source*, or a *journalist* would read them. Those two experiences are called
the *Source Interface* and the *Journalist Interface*.

In order to review the demo server as a *source*:

#. Visit `SecureDrop's demo server`_.
#. Click on the "Source Interface" link.

In order to review the demo server as a *journalist*:

#. Visit `SecureDrop's demo server`_.
#. Take note of the **username**, **passphrase** and **current TOTP token**
at the bottom of the page; you will need them to log in.
#. Click on the "Journalist Interface" link.
#. Input the **username**, **passphrase** and **current TOTP token**
("Two-factor Code") to log in.

.. _`SecureDrop's demo server`: https://demo.securedrop.org

.. _how_to_become_a_reviewer:

How to become a reviewer
Expand Down