mirror of https://github.com/privacyguides/privacyguides.org synced 2024-11-10 05:03:34 +01:00

feat: Ensure all pages have proper descriptions (#2752 )

Signed-off-by: blacklight447 <niek@privacyguides.org>
Signed-off-by: kimg45 <138676274+kimg45@users.noreply.github.com>
Signed-off-by: Daniel Gray <dngray@privacyguides.org>

2024-09-22 17:57:17 +09:30

5.5 KiB

Raw Permalink Blame History

date

Privacy Guides Is Now Multilingual

It's finally here. After countless requests, Privacy Guides now has translations.

People have always asked us for translations to other languages because our team and community produces high quality, reliable, honest, and researched content. Our previous site never had a system for this. All translations were done manually, and translators would quickly lose interest. Translated sites would be outdated and lay unmaintained on domains that we didn't own. Privacy Guides now has a proper system.

Our site runs Material for MkDocs, which supports internationalization. This allows us to provide language specific content without the mammoth effort previously required.

What we're planning

You can expect translations of this blog – and lots more content. We will add languages to the site when they near completion. That way they can be checked to make sure they maintain the high quality that people have come to expect from the rest of Privacy Guides.

Translators

We'd also like to remind everyone you can stay up to date with the main site by looking at our release page, this will show major changes to the main content. You can subscribe with a News Aggregator:

The blog doesn't have releases, but articles are generally published in a complete state and only updated with minor changes.

Feel free to check out our localization room on Matrix #pg-i18n:aragon.sh if you have any questions on getting started. You can find us on Crowdin.

Please note that the English version of the site is the primary version, meaning changes occur there first. This means it is still possible that specific languages may be behind. If you notice such an instance please help out. We cannot guarantee the accuracy of all our translations. If you have a suggestion about content specific to your region, please open an issue or pull request to our main repository.

Some tips for translators

Crowdin has good documentation and we suggest looking at their Getting Started guide. Our site is in Markdown, so it should be easy to chip in.

Admonitions

Throughout the site we use MkDocs's admonitions, to show information to readers about the products such as example, warning, tip, etc.

By default when admonitions are used they will have an English string on the site. This can be customized, without too much effort. For example if you were translating and admonition of type warning to Dutch, this is how you would write it:

!!! warning "Waarschuwing"

Downloads are a custom admonition that we use and you would write that like:

??? downloads "Downloaden"

The same goes for other types, such as tip, example etc. Recommendations are also admonitions, but they do not need overriding, because the default has no text, so they are always:

!!! recommendation

Translation software

Translation software gets the translation quite reliable. We've found DeepL works well however, attention does need to be given that the translated string is correct.

For example:

![Software logo](assets/img/path/to/image.svg){ align=right }

We have sometimes found that the syntax for inserting an image like above was missing the ![ or an extra space was placed between the text and the path, eg ](. If a translation string is clearly not correct, we encourage you to delete it by pressing the trash icon or vote which one you think sounds best. When invalid strings are deleted they are removed from the organization's translation memory, meaning that when the source string is seen again, it won't suggest the incorrect translation.

We'd like to thank the translation team who spent many hours on translating the content, that we now have. We're going to launch in Dutch, French and Hebrew.

5.5 KiB Raw Permalink Blame History Unescape Escape