prettier

privacyguides · Mar 31, 2024 · faa08e4 · faa08e4
1 parent b30fb9b
commit faa08e4
Show file tree

Hide file tree

Showing 20 changed files with 155 additions and 139 deletions.
diff --git a/.github/workflows/build-offline.yml b/.github/workflows/build-offline.yml
@@ -36,7 +36,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          persist-credentials: 'false'
+          persist-credentials: "false"
 
       - uses: actions/download-artifact@v4
         with:
@@ -52,8 +52,8 @@ jobs:
       - name: Python setup
         uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
-          cache: 'pipenv'
+          python-version: "3.8"
+          cache: "pipenv"
 
       - uses: actions/cache/[email protected]
         with:

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -54,7 +54,7 @@ jobs:
         with:
           repository: ${{ inputs.repo }}
           ref: ${{ inputs.ref }}
-          persist-credentials: 'false'
+          persist-credentials: "false"
           fetch-depth: 0
 
       - uses: actions/download-artifact@v4
@@ -76,8 +76,8 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
-          cache: 'pipenv'
+          python-version: "3.8"
+          cache: "pipenv"
 
       - uses: actions/cache/[email protected]
         with:

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -142,8 +142,8 @@ jobs:
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:
       contents: read
-      pages: write      # to deploy to Pages
-      id-token: write   # to verify the deployment originates from an appropriate source
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
 
     steps:
       - uses: actions/configure-pages@v5

diff --git a/.github/workflows/download-repo.yml b/.github/workflows/download-repo.yml
@@ -40,7 +40,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          repository: 'privacyguides/${{ inputs.repo }}'
+          repository: "privacyguides/${{ inputs.repo }}"
           path: repo-${{ inputs.repo }}
           ssh-key: ${{ secrets.ACTIONS_SSH_KEY }}
 

diff --git a/.github/workflows/publish-mirror.yml b/.github/workflows/publish-mirror.yml
@@ -23,7 +23,7 @@ name: 🪞 Push to Mirrors
 permissions:
   contents: read
 
-on: [ push, delete, create ]
+on: [push, delete, create]
 
 # Ensures that only one mirror task will run at a time.
 concurrency:

diff --git a/.github/workflows/publish-pr.yml b/.github/workflows/publish-pr.yml
@@ -84,7 +84,6 @@ jobs:
     env:
       address: ${{ needs.deploy.outputs.netlify_preview_address }}
     steps:
-
       - uses: thollander/[email protected]
         with:
           message: |

diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -23,7 +23,7 @@ name: 📦 Release
 on:
   push:
     tags:
-      - '*'
+      - "*"
 
 permissions:
   contents: write

diff --git a/.github/workflows/test-lint.yml b/.github/workflows/test-lint.yml
@@ -29,28 +29,36 @@ on:
     branches:
       - main
   push:
-    branches:
-      - main
 
 concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}
   cancel-in-progress: true
 
-jobs:
+env:
+  MAIN_BRANCH: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
 
+jobs:
   megalinter:
+    name: MegaLinter
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: MegaLinter
-        id: ml
+      - if: ${{ env.MAIN_BRANCH }}
+        uses: actions/checkout@v4
+
+      - if: ${{ !env.MAIN_BRANCH }}
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - id: ml
         # You can override MegaLinter flavor used to have faster performances
         # More info at https://megalinter.io/flavors/
         uses: oxsecurity/megalinter/flavors/[email protected]
         env:
           # All available variables are described in documentation
           # https://megalinter.io/configuration/
-          VALIDATE_ALL_CODEBASE: true
+          # Validates all source when push on main, else just the git diff with main.
+          VALIDATE_ALL_CODEBASE: ${{ env.MAIN_BRANCH }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
           DISABLE: COPYPASTE,SPELL,HTML

diff --git a/.github/workflows/upload-crowdin.yml b/.github/workflows/upload-crowdin.yml
@@ -26,7 +26,7 @@ permissions:
 on:
   workflow_dispatch:
   push:
-    branches: [ main ]
+    branches: [main]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -37,18 +37,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: crowdin action
-      uses: crowdin/[email protected]
-      with:
-        upload_sources: true
-        upload_sources_args: '--auto-update --delete-obsolete'
-        download_translations: false
-        config: crowdin.yml
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-        CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: crowdin action
+        uses: crowdin/[email protected]
+        with:
+          upload_sources: true
+          upload_sources_args: "--auto-update --delete-obsolete"
+          download_translations: false
+          config: crowdin.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -45,5 +45,6 @@
       "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
       "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
       "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg"
-    ]
+    ],
+    "editor.formatOnSave": true
 }
diff --git a/config/mkdocs-common.yml b/config/mkdocs-common.yml
@@ -18,20 +18,29 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-docs_dir: '../docs'
+docs_dir: "../docs"
 site_url: "https://www.privacyguides.org/"
-site_dir: '../site'
+site_dir: "../site"
 
 site_name: Privacy Guides
-site_description: !ENV [SITE_DESCRIPTION, "Privacy Guides is your central privacy and security resource to protect yourself online."]
-copyright: !ENV [FOOTER_COPYRIGHT, "&copy; 2019 Privacy Guides and contributors."]
+site_description:
+  !ENV [
+    SITE_DESCRIPTION,
+    "Privacy Guides is your central privacy and security resource to protect yourself online.",
+  ]
+copyright:
+  !ENV [FOOTER_COPYRIGHT, "&copy; 2019 Privacy Guides and contributors."]
 edit_uri: edit/main/docs/
 
 extra:
   generator: false
   context: !ENV [CONTEXT, "production"]
   deploy: !ENV DEPLOY_ID
-  homepage_description: !ENV [DESCRIPTION_HOMEPAGE, "A socially motivated website which provides information about protecting your online data privacy and security."]
+  homepage_description:
+    !ENV [
+      DESCRIPTION_HOMEPAGE,
+      "A socially motivated website which provides information about protecting your online data privacy and security.",
+    ]
   translation_notice: !ENV DESCRIPTION_TRANSLATION
   translation_notice_cta: !ENV [DESCRIPTION_TRANSLATION_CTA, "Visit Crowdin"]
   translation_notice_language: !ENV LANG_ENGLISH
@@ -204,85 +213,86 @@ markdown_extensions:
     toc_depth: 4
 
 nav:
-  - !ENV [NAV_HOME, 'Home']: 'index.md'
-  - !ENV [NAV_KNOWLEDGE_BASE, 'Knowledge Base']:
-    - 'basics/why-privacy-matters.md'
-    - 'basics/threat-modeling.md'
-    - 'basics/common-threats.md'
-    - 'basics/common-misconceptions.md'
-    - 'basics/account-creation.md'
-    - 'basics/account-deletion.md'
-    - !ENV [NAV_TECHNOLOGY_ESSENTIALS, 'Technology Essentials']:
-      - 'basics/passwords-overview.md'
-      - 'basics/multi-factor-authentication.md'
-      - 'basics/email-security.md'
-      - 'basics/vpn-overview.md'
-    - !ENV [NAV_ADVANCED_TOPICS, 'Advanced Topics']:
-      - 'advanced/dns-overview.md'
-      - 'advanced/tor-overview.md'
-      - 'advanced/payments.md'
-      - 'advanced/communication-network-types.md'
-    - !ENV [NAV_OPERATING_SYSTEMS, 'Operating Systems']:
-      - 'os/android-overview.md'
-      - 'os/ios-overview.md'
-      - 'os/linux-overview.md'
-      - 'os/macos-overview.md'
-      - 'os/qubes-overview.md'
-    - kb-archive.md
-  - !ENV [NAV_RECOMMENDATIONS, 'Recommendations']:
-    - 'tools.md'
-    - !ENV [NAV_INTERNET_BROWSING, 'Internet Browsing']:
-      - 'tor.md'
-      - 'desktop-browsers.md'
-      - 'mobile-browsers.md'
-    - !ENV [NAV_PROVIDERS, 'Providers']:
-      - 'cloud.md'
-      - 'dns.md'
-      - 'email-aliasing.md'
-      - 'email.md'
-      - 'financial-services.md'
-      - 'photo-management.md'
-      - 'search-engines.md'
-      - 'vpn.md'
-    - !ENV [NAV_SOFTWARE, 'Software']:
-      - 'calendar.md'
-      - 'cryptocurrency.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'
-    - !ENV [NAV_OPERATING_SYSTEMS, 'Operating Systems']:
-      - 'android.md'
-      - 'desktop.md'
-      - 'router.md'
-    - !ENV [NAV_ADVANCED, 'Advanced']:
-      - 'device-integrity.md'
-  - !ENV [NAV_ABOUT, 'About']:
-    - 'about/index.md'
-    - 'about/criteria.md'
-    - 'about/notices.md'
-    - 'about/privacy-policy.md'
-    - !ENV [NAV_COMMUNITY, 'Community']:
-      - 'about/donate.md'
-      - !ENV [NAV_ONLINE_SERVICES, 'Online Services']: 'about/services.md'
-      - !ENV [NAV_CODE_OF_CONDUCT, 'Code of Conduct']: 'CODE_OF_CONDUCT.md'
-      - 'about/privacytools.md'
-    - !ENV [NAV_CONTRIBUTING, 'Contributing']:
-      - !ENV [NAV_WRITING_GUIDE, 'Writing Guide']:
-        - 'meta/writing-style.md'
-        - 'meta/admonitions.md'
-        - 'meta/brand.md'
-        - 'meta/translations.md'
-      - !ENV [NAV_TECHNICAL_GUIDES, 'Technical Guides']:
-        - 'meta/uploading-images.md'
-        - 'meta/git-recommendations.md'
-  - !ENV [NAV_CHANGELOG, 'Changelog']: 'https://github.com/privacyguides/privacyguides.org/releases'
-  - !ENV [NAV_FORUM, 'Forum']: 'https://discuss.privacyguides.net/'
-  - !ENV [NAV_BLOG, 'Blog']: 'https://blog.privacyguides.org/'
+  - !ENV [NAV_HOME, "Home"]: "index.md"
+  - !ENV [NAV_KNOWLEDGE_BASE, "Knowledge Base"]:
+      - "basics/why-privacy-matters.md"
+      - "basics/threat-modeling.md"
+      - "basics/common-threats.md"
+      - "basics/common-misconceptions.md"
+      - "basics/account-creation.md"
+      - "basics/account-deletion.md"
+      - !ENV [NAV_TECHNOLOGY_ESSENTIALS, "Technology Essentials"]:
+          - "basics/passwords-overview.md"
+          - "basics/multi-factor-authentication.md"
+          - "basics/email-security.md"
+          - "basics/vpn-overview.md"
+      - !ENV [NAV_ADVANCED_TOPICS, "Advanced Topics"]:
+          - "advanced/dns-overview.md"
+          - "advanced/tor-overview.md"
+          - "advanced/payments.md"
+          - "advanced/communication-network-types.md"
+      - !ENV [NAV_OPERATING_SYSTEMS, "Operating Systems"]:
+          - "os/android-overview.md"
+          - "os/ios-overview.md"
+          - "os/linux-overview.md"
+          - "os/macos-overview.md"
+          - "os/qubes-overview.md"
+      - kb-archive.md
+  - !ENV [NAV_RECOMMENDATIONS, "Recommendations"]:
+      - "tools.md"
+      - !ENV [NAV_INTERNET_BROWSING, "Internet Browsing"]:
+          - "tor.md"
+          - "desktop-browsers.md"
+          - "mobile-browsers.md"
+      - !ENV [NAV_PROVIDERS, "Providers"]:
+          - "cloud.md"
+          - "dns.md"
+          - "email-aliasing.md"
+          - "email.md"
+          - "financial-services.md"
+          - "photo-management.md"
+          - "search-engines.md"
+          - "vpn.md"
+      - !ENV [NAV_SOFTWARE, "Software"]:
+          - "calendar.md"
+          - "cryptocurrency.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"
+      - !ENV [NAV_OPERATING_SYSTEMS, "Operating Systems"]:
+          - "android.md"
+          - "desktop.md"
+          - "router.md"
+      - !ENV [NAV_ADVANCED, "Advanced"]:
+          - "device-integrity.md"
+  - !ENV [NAV_ABOUT, "About"]:
+      - "about/index.md"
+      - "about/criteria.md"
+      - "about/notices.md"
+      - "about/privacy-policy.md"
+      - !ENV [NAV_COMMUNITY, "Community"]:
+          - "about/donate.md"
+          - !ENV [NAV_ONLINE_SERVICES, "Online Services"]: "about/services.md"
+          - !ENV [NAV_CODE_OF_CONDUCT, "Code of Conduct"]: "CODE_OF_CONDUCT.md"
+          - "about/privacytools.md"
+      - !ENV [NAV_CONTRIBUTING, "Contributing"]:
+          - !ENV [NAV_WRITING_GUIDE, "Writing Guide"]:
+              - "meta/writing-style.md"
+              - "meta/admonitions.md"
+              - "meta/brand.md"
+              - "meta/translations.md"
+          - !ENV [NAV_TECHNICAL_GUIDES, "Technical Guides"]:
+              - "meta/uploading-images.md"
+              - "meta/git-recommendations.md"
+  - !ENV [NAV_CHANGELOG, "Changelog"]:
+      "https://github.com/privacyguides/privacyguides.org/releases"
+  - !ENV [NAV_FORUM, "Forum"]: "https://discuss.privacyguides.net/"
+  - !ENV [NAV_BLOG, "Blog"]: "https://blog.privacyguides.org/"
diff --git a/config/mkdocs-offline.yml b/config/mkdocs-offline.yml
@@ -44,5 +44,4 @@ plugins:
     enabled: true
   social:
     enabled: false
-
 # Edit the offline-mode navbar in mkdocs-common.yml
diff --git a/config/mkdocs.en.yml b/config/mkdocs.en.yml
@@ -20,7 +20,7 @@
 
 INHERIT: mkdocs-common.yml
 site_url: "https://www.privacyguides.org/en/"
-site_dir: '../site/en'
+site_dir: "../site/en"
 
 theme:
   # ENGLISH ONLY: this logo needs to be set separately because the relative path is different