From 3ad66a447f0bc994c24312c26fffd062f8773540 Mon Sep 17 00:00:00 2001 From: Daniel Gray Date: Wed, 13 Mar 2024 04:58:48 +0000 Subject: [PATCH] Remove admonition section from translation (#2436) --- docs/about/criteria.md | 7 +++-- docs/about/index.md | 6 +++-- docs/about/notices.md | 6 +++-- docs/basics/threat-modeling.md | 2 +- docs/meta/translations.md | 48 ---------------------------------- 5 files changed, 14 insertions(+), 55 deletions(-) diff --git a/docs/about/criteria.md b/docs/about/criteria.md index 80fa649f..ccb7e87d 100644 --- a/docs/about/criteria.md +++ b/docs/about/criteria.md @@ -2,9 +2,12 @@ title: General Criteria --- -!!! example "Work in Progress" +
+

Work in Progress

- The following page is a work in progress, and does not reflect the full criteria for our recommendations at this time. Past discussion on this topic: [#24](https://github.com/privacyguides/privacyguides.org/discussions/24) +The following page is a work in progress, and does not reflect the full criteria for our recommendations at this time. Past discussion on this topic: [#24](https://github.com/privacyguides/privacyguides.org/discussions/24) + +
Below are some things that must apply to all submissions to Privacy Guides. Each category will have additional requirements for inclusion. diff --git a/docs/about/index.md b/docs/about/index.md index bd395d5e..321f55e1 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -86,9 +86,11 @@ Our team members review all changes made to the website and handle administrativ ## Site License -!!! danger "" +
- The following is a human-readable summary of (and not a substitute for) the [license](/license). +The following is a human-readable summary of (and not a substitute for) the [license](/license). + +
:fontawesome-brands-creative-commons: :fontawesome-brands-creative-commons-by: :fontawesome-brands-creative-commons-nd: Unless otherwise noted, the original content on this website is made available under the [Creative Commons Attribution-NoDerivatives 4.0 International Public License](https://github.com/privacyguides/privacyguides.org/blob/main/LICENSE). This means that you are free to copy and redistribute the material in any medium or format for any purpose, even commercially; as long as you give appropriate credit to `Privacy Guides (www.privacyguides.org)` and provide a link to the license. You may do so in any reasonable manner, but not in any way that suggests Privacy Guides endorses you or your use. If you remix, transform, or build upon the content of this website, you may not distribute the modified material. diff --git a/docs/about/notices.md b/docs/about/notices.md index 0ef0e6f8..892c40a5 100644 --- a/docs/about/notices.md +++ b/docs/about/notices.md @@ -14,9 +14,11 @@ Privacy Guides additionally does not warrant that this website will be constantl ## Licensing Overview -!!! danger "" +
- The following is a human-readable summary of (and not a substitute for) the [license](/license). +The following is a human-readable summary of (and not a substitute for) the [license](/license). + +
Unless otherwise noted, all **content** on this website is made available under the terms of the [Creative Commons Attribution-NoDerivatives 4.0 International Public License](https://github.com/privacyguides/privacyguides.org/blob/main/LICENSE). The underlying **source code** used to generate this website and display that content is released under the [MIT License](https://github.com/privacyguides/privacyguides.org/tree/main/LICENSE-CODE). diff --git a/docs/basics/threat-modeling.md b/docs/basics/threat-modeling.md index 92b5f571..1fa25d79 100644 --- a/docs/basics/threat-modeling.md +++ b/docs/basics/threat-modeling.md @@ -97,7 +97,7 @@ Making a security plan will help you to understand the threats that are unique t ## Further Reading -For people looking to increase their privacy and security online, we've compiled a list of common threats our visitors face or goals our visitors have, to give you some inspiration and demonstrate the basis of our recommendations. +For people looking to increase their privacy and security online, we've compiled a list of common threats our visitors face or goals our visitors have, to give you some inspiration and demonstrate the basis of our recommendations. - [Common Goals and Threats :material-arrow-right-drop-circle:](common-threats.md) diff --git a/docs/meta/translations.md b/docs/meta/translations.md index 60261b1c..5fddd290 100644 --- a/docs/meta/translations.md +++ b/docs/meta/translations.md @@ -8,54 +8,6 @@ Please join our localization room on Matrix ([#pg-i18n:aragon.sh](https://matrix Note that the English version of the site is the primary version, meaning changes occur there first. If you notice a language falling behind the English version, 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](https://github.com/privacyguides/privacyguides.org). -## Admonitions - -Throughout the site we use MkDocs's [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage), to show information to readers. They come in a few different flavors such as `example`, `warning`, `tip`, etc. - -When admonitions are used they will have an English string on the site by default. This can be [customized](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#changing-the-title), without too much effort. For example, if you were translating an admonition of type [`warning`](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#type:warning) to Dutch, this is how you would write it: - -=== "Dutch translation" - - ```text - !!! warning "Waarschuwing" - ``` - -=== "English source text" - - ```text - !!! warning - ``` - -Downloads are a [custom admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#custom-admonitions) which is written as follows: - -=== "Dutch translation" - - ```text - ??? downloads "Downloaden" - ``` - -=== "English source text" - - ```text - ??? downloads - ``` - -The same goes for other types, such as `tip`, `example`, `warning`, `danger` etc. - -Recommendations are a special type of admonition which do **not** need overriding as they have no visible text, so they are never changed: - -=== "Dutch translation" - - ```text - !!! recommendation - ``` - -=== "English source text" - - ```text - !!! recommendation - ``` - ## Translation output Translation software gets the translation quite accurate; however, you need to make sure the translated string is correct.