Skip to content

Commit

Permalink
Fixing translation docs (#965)
Browse files Browse the repository at this point in the history
  • Loading branch information
kazet committed May 8, 2024
1 parent f54326d commit 5e03b39
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/user-guide/translating-report-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,22 @@ The translations reside in:
Adding a new language
---------------------

If you want to support a new language, add it in ``./scripts/update_translation_files`` and
``artemis/reporting/base/language.py``.
If you want to support a new language:

The following message files need to be created manually when adding support for a new
language:
- add it in ``./scripts/update_translation_files``,
- add it in ``artemis/reporting/base/language.py``,
- if you want SPF/DMARC verification messages to be supported, add support in https://github.com/CERT-Polska/mailgoose
(https://mailgoose.readthedocs.io/en/latest/user-guide/translation.html).

- ``artemis/reporting/modules/nuclei/translations/nuclei_messages/{language}.py`` - this file
contains Nuclei message translations,
- ``artemis/reporting/modules/mail_dns_scanner/translations/{language}/additional.po`` - this file
contains translations for the e-mail configuration (SPF, DMARC) check library messages (you may
copy and modify ``artemis/reporting/modules/mail_dns_scanner/translations/pl_PL/additional.po``).
The following file need to be created manually when adding support for a new
language: ``artemis/reporting/modules/nuclei/translations/nuclei_messages/{language}.py`` - this file
contains Nuclei message translations.

If you want to add or modify all other translation messages, first update the translation files by using:

``./scripts/update_translation_files``

and then put the translations in the respective ``.po`` files. The compilation will happen
automatically when building the report messages.

**You don't have to translate everything - pull requests with partial translations are also welcome!**

0 comments on commit 5e03b39

Please sign in to comment.