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

Stop using i18n plugin #2054

Merged
merged 2 commits into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 1 addition & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,5 @@
path = modules/mkdocs-material
url = git@github.com:privacyguides/mkdocs-material-insiders.git
[submodule "docs/assets/brand"]
path = docs/assets/brand
path = theme/assets/brand
url = https://github.com/privacyguides/brand.git
[submodule "mkdocs-static-i18n"]
path = modules/mkdocs-static-i18n
url = git@github.com:privacyguides/mkdocs-static-i18n.git
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
<a href="https://github.com/privacyguides/privacyguides.org/pulls?q=is%3Apr+is%3Aclosed">
<img src="https://img.shields.io/github/issues-pr-closed-raw/privacyguides/privacyguides.org">
</a>
<a href="https://crowdin.com/project/privacyguides">
<img src="https://badges.crowdin.net/privacyguides/localized.svg">
</a>
<a href="https://opencollective.com/privacyguides">
<img src="https://img.shields.io/opencollective/all/privacyguides">
</a></p>
Expand Down Expand Up @@ -60,19 +63,7 @@ Our current list of team members can be found [here](https://www.privacyguides.o

Committing to this repository requires [signing your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) (`git config commit.gpgsign true`) unless you are making edits via the GitHub.com text editor interface. As of August 2022 the preferred signing method is [SSH commit signatures](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification), but GPG signing is also acceptable. You should add your signing key to your GitHub profile.

This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdocs-material/insiders/) which offers additional functionality over the open-source `mkdocs-material` project. For obvious reasons we cannot distribute access to the insiders repository. You can install the website locally with the open-source version of `mkdocs-material`:

1. Clone this repository:
- `git clone https://github.com/privacyguides/privacyguides.org.git` (then `cd privacyguides.org`)
- `git submodule init`
- `git submodule update docs/assets/brand`
- `git config gpg.ssh.allowedSignersFile .allowed_signers`
2. Install [Python 3.6+](https://www.python.org/downloads/) (currently only tested with 3.10)
3. Install [dependencies](/Pipfile): `pip install mkdocs mkdocs-material mkdocs-static-i18n mkdocs-macros-plugin typing-extensions`
4. Serve the site locally: `mkdocs serve`
- The site will be available at `http://localhost:8000`
- You can build the site locally with `mkdocs build`
- Your local version of the site may be missing functionality, which is expected. If you are submitting a PR, please ensure the automatic preview generated for your PR looks correct, as that site will be built with the production insiders build.
This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdocs-material/insiders/) which offers additional functionality over the open-source `mkdocs-material` project. For obvious reasons we cannot distribute access to the insiders repository. Running this website locally without access to insiders is unsupported. If you are submitting a PR, please ensure the automatic preview generated for your PR looks correct, as that site will be built with the production insiders build.

**Team members** should clone the repository with `mkdocs-material-insiders` directly. This method is identical to production:

Expand All @@ -81,9 +72,9 @@ This website uses [`mkdocs-material-insiders`](https://squidfunk.github.io/mkdoc
3. Install Python **3.10**
4. Install **pipenv**: `pip install pipenv`
5. Install dependencies: `pipenv install --dev` (install [Pillow and CairoSVG](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#dependencies) as well to generate social cards)
6. Serve the site locally: `pipenv run mkdocs serve --config-file mkdocs.production.yml` (set `CARDS=true` to generate social cards)
6. Serve the site locally: `pipenv run mkdocs serve --config-file config/mkdocs.en.yml` (set `CARDS=true` to generate social cards)
- The site will be available at `http://localhost:8000`
- You can build the site locally with `pipenv run mkdocs build`
- You can build the site locally with `pipenv run mkdocs build --config-file config/mkdocs.en.yml`
- This version of the site should be identical to the live, production version

If you commit to `main` with commits signed with your SSH key, you should add your SSH key to [`.allowed_signers`](/.allowed_signers) in this repo.
Expand Down
61 changes: 61 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/ /en/ 302 Language=en
/ /fr/ 302 Language=fr
/ /he/ 302 Language=he
/ /nl/ 302 Language=nl
/ /en/ 302

/sitemap.xml /en/sitemap.xml
/CODE_OF_CONDUCT/ /en/CODE_OF_CONDUCT/
/android/ /en/android/
/calendar/ /en/calendar/
/cloud/ /en/cloud/
/data-redaction/ /en/data-redaction/
/desktop-browsers/ /en/desktop-browsers/
/desktop/ /en/desktop/
/dns/ /en/dns/
/email-clients/ /en/email-clients/
/email/ /en/email/
/encryption/ /en/encryption/
/file-sharing/ /en/file-sharing/
/frontends/ /en/frontends/
/kb-archive/ /en/kb-archive/
/mobile-browsers/ /en/mobile-browsers/
/multi-factor-authentication/ /en/multi-factor-authentication/
/news-aggregators/ /en/news-aggregators/
/notebooks/ /en/notebooks/
/passwords/ /en/passwords/
/productivity/ /en/productivity/
/real-time-communication/ /en/real-time-communication/
/router/ /en/router/
/search-engines/ /en/search-engines/
/tools/ /en/tools/
/tor/ /en/tor/
/video-streaming/ /en/video-streaming/
/vpn/ /en/vpn/
/about/criteria/ /en/about/criteria/
/about/donate/ /en/about/donate/
/about/ /en/about/
/about/notices/ /en/about/notices/
/about/privacy-policy/ /en/about/privacy-policy/
/about/privacytools/ /en/about/privacytools/
/about/services/ /en/about/services/
/about/statistics/ /en/about/statistics/
/advanced/communication-network-types/ /en/advanced/communication-network-types/
/advanced/dns-overview/ /en/advanced/dns-overview/
/advanced/tor-overview/ /en/advanced/tor-overview/
/basics/account-creation/ /en/basics/account-creation/
/basics/account-deletion/ /en/basics/account-deletion/
/basics/common-misconceptions/ /en/basics/common-misconceptions/
/basics/common-threats/ /en/basics/common-threats/
/basics/email-security/ /en/basics/email-security/
/basics/multi-factor-authentication/ /en/basics/multi-factor-authentication/
/basics/passwords-overview/ /en/basics/passwords-overview/
/basics/threat-modeling/ /en/basics/threat-modeling/
/basics/vpn-overview/ /en/basics/vpn-overview/
/meta/brand/ /en/meta/brand/
/meta/git-recommendations/ /en/meta/git-recommendations/
/meta/uploading-images/ /en/meta/uploading-images/
/meta/writing-style/ /en/meta/writing-style/
/os/android-overview/ /en/os/android-overview/
/os/linux-overview/ /en/os/linux-overview/
/os/qubes-overview/ /en/os/qubes-overview/
147 changes: 147 additions & 0 deletions config/mkdocs.ar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
INHERIT: mkdocs.common.yml
docs_dir: '../docs'
site_url: "https://www.privacyguides.org/en/"
site_dir: '../site/en'
site_name: Privacy Guides
site_description: |
Privacy Guides is your central privacy and security resource to protect yourself online.
copyright: |
<b>Privacy Guides</b> is a non-profit, socially motivated website that provides information for protecting your data security and privacy.<br>
We do not make money from recommending certain products, and we do not use affiliate links.<br>
&copy; 2022 Privacy Guides and contributors. <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m245.83 214.87-33.22 17.28c-9.43-19.58-25.24-19.93-27.46-19.93-22.13 0-33.22 14.61-33.22 43.84 0 23.57 9.21 43.84 33.22 43.84 14.47 0 24.65-7.09 30.57-21.26l30.55 15.5c-6.17 11.51-25.69 38.98-65.1 38.98-22.6 0-73.96-10.32-73.96-77.05 0-58.69 43-77.06 72.63-77.06 30.72-.01 52.7 11.95 65.99 35.86zm143.05 0-32.78 17.28c-9.5-19.77-25.72-19.93-27.9-19.93-22.14 0-33.22 14.61-33.22 43.84 0 23.55 9.23 43.84 33.22 43.84 14.45 0 24.65-7.09 30.54-21.26l31 15.5c-2.1 3.75-21.39 38.98-65.09 38.98-22.69 0-73.96-9.87-73.96-77.05 0-58.67 42.97-77.06 72.63-77.06 30.71-.01 52.58 11.95 65.56 35.86zM247.56 8.05C104.74 8.05 0 123.11 0 256.05c0 138.49 113.6 248 247.56 248 129.93 0 248.44-100.87 248.44-248 0-137.87-106.62-248-248.44-248zm.87 450.81c-112.54 0-203.7-93.04-203.7-202.81 0-105.42 85.43-203.27 203.72-203.27 112.53 0 202.82 89.46 202.82 203.26-.01 121.69-99.68 202.82-202.84 202.82z"></path></svg></span><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M314.9 194.4v101.4h-28.3v120.5h-77.1V295.9h-28.3V194.4c0-4.4 1.6-8.2 4.6-11.3 3.1-3.1 6.9-4.7 11.3-4.7H299c4.1 0 7.8 1.6 11.1 4.7 3.1 3.2 4.8 6.9 4.8 11.3zm-101.5-63.7c0-23.3 11.5-35 34.5-35s34.5 11.7 34.5 35c0 23-11.5 34.5-34.5 34.5s-34.5-11.5-34.5-34.5zM247.6 8C389.4 8 496 118.1 496 256c0 147.1-118.5 248-248.4 248C113.6 504 0 394.5 0 256 0 123.1 104.7 8 247.6 8zm.8 44.7C130.2 52.7 44.7 150.6 44.7 256c0 109.8 91.2 202.8 203.7 202.8 103.2 0 202.8-81.1 202.8-202.8.1-113.8-90.2-203.3-202.8-203.3z"></path></svg></span><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M247.6 8C389.4 8 496 118.1 496 256c0 147.1-118.5 248-248.4 248C113.6 504 0 394.5 0 256 0 123.1 104.7 8 247.6 8zm.8 44.7C130.2 52.7 44.7 150.6 44.7 256c0 109.8 91.2 202.8 203.7 202.8 103.2 0 202.8-81.1 202.8-202.8.1-113.8-90.2-203.3-202.8-203.3zm94 144.3v42.5H162.1V197h180.3zm0 79.8v42.5H162.1v-42.5h180.3z"></path></svg></span> Content licensed under <a href="/about/"><strong>CC BY-ND 4.0</strong></a>.
edit_uri: edit/main/docs/
extra:
generator: false
analytics:
provider: plausible
property: privacyguides.org
feedback:
title: "Was this page helpful?"
ratings:
-
icon: material/robot-happy-outline
name: "This page was helpful"
data: Helpful
note: "Thanks for your feedback!"
-
icon: material/robot-confused
name: "This page could be improved"
data: Needs Improvement
note: "Thanks for your feedback! Help us improve this page by opening a <a href='https://discuss.privacyguides.net/'>discussion on our forum</a>."
theme:
language: en
palette:
-
media: "(prefers-color-scheme)"
scheme: default
accent: deep purple
toggle:
icon: material/brightness-auto
name: "Switch to light mode"
-
media: "(prefers-color-scheme: dark)"
scheme: slate
accent: amber
toggle:
icon: material/brightness-2
name: "Switch to system theme"
-
media: "(prefers-color-scheme: light)"
scheme: default
accent: deep purple
toggle:
icon: material/brightness-5
name: "Switch to dark mode"
nav:
-
Home: 'index.md'
-
Knowledge Base:
- 'basics/threat-modeling.md'
- 'basics/common-threats.md'
- 'basics/common-misconceptions.md'
- 'basics/account-creation.md'
- 'basics/account-deletion.md'
-
Technology Essentials:
- 'basics/passwords-overview.md'
- 'basics/multi-factor-authentication.md'
- 'basics/email-security.md'
- 'basics/vpn-overview.md'
-
Operating Systems:
- 'os/android-overview.md'
- 'os/linux-overview.md'
- 'os/qubes-overview.md'
-
Advanced Topics:
- 'advanced/dns-overview.md'
- 'advanced/tor-overview.md'
- 'advanced/communication-network-types.md'
- kb-archive.md
-
Recommendations:
- 'tools.md'
-
Internet Browsing:
- 'tor.md'
- 'desktop-browsers.md'
- 'mobile-browsers.md'
-
Operating Systems:
- 'android.md'
- 'desktop.md'
- 'router.md'
-
Providers:
- 'cloud.md'
- 'dns.md'
- 'email.md'
- 'search-engines.md'
- 'vpn.md'
-
Software:
- 'calendar.md'
- 'data-redaction.md'
- 'email-clients.md'
- 'encryption.md'
- 'file-sharing.md'
- 'frontends.md'
- 'multi-factor-authentication.md'
- 'news-aggregators.md'
- 'notebooks.md'
- 'passwords.md'
- 'productivity.md'
- 'real-time-communication.md'
- 'video-streaming.md'
-
About:
- 'about/index.md'
- 'about/criteria.md'
- 'about/statistics.md'
- 'about/notices.md'
- 'about/privacy-policy.md'
-
Community:
- 'about/donate.md'
-
Online Services: 'about/services.md'
-
Code of Conduct: 'CODE_OF_CONDUCT.md'
- 'about/privacytools.md'
-
Contributing:
-
Writing Guide:
- 'meta/writing-style.md'
- 'meta/brand.md'
-
Technical Guides:
- 'meta/uploading-images.md'
- 'meta/git-recommendations.md'
-
Changelog: 'https://github.com/privacyguides/privacyguides.org/releases'
-
Forum: 'https://discuss.privacyguides.net/'
-
Blog: 'https://blog.privacyguides.org/'