mirror of https://github.com/privacyguides/privacyguides.org.git synced 2024-07-22 02:07:28 +00:00
Protect your data against global mass surveillance programs.
Go to file
2022-04-27 16:04:13 -05:00
.github Fix broken PR preview teardowns 2022-04-26 23:13:24 -05:00
.well-known Clean up the cruft 2021-01-15 23:46:23 -06:00
docs Move email cloaking services and self-hosted email up (#1123) 2022-04-27 16:03:03 -05:00
includes Update SearXNG wording and mention it is a fork (#1101) 2022-04-26 00:42:36 +09:30
mkdocs-material@f02ab2a15e Netlify PR Previews (#915) 2022-04-05 12:29:24 -05:00
theme Add online services and donation information (#1110) 2022-04-26 23:15:21 -05:00
.allowed_signers Enable SSH Git commit signing (#1122) 2022-04-27 16:04:13 -05:00
.gitattributes Mark .md files as linguist-detectable 2022-04-12 17:37:31 -05:00
.gitignore Transition to mkdocs (#829) 2022-04-02 06:59:03 +10:30
.gitmodules Netlify PR Previews (#915) 2022-04-05 12:29:24 -05:00
.markdownlint.yml Page formatting consistency (#913) 2022-04-05 10:49:24 -05:00
crowdin.yml Use abbreviations across site (#1060) 2022-04-22 12:06:26 -05:00
LICENSE Proper Content Licensing 2021-09-16 09:57:21 -05:00
mkdocs.yml Privacy plugin stats exemption 2022-04-26 23:23:40 -05:00
Pipfile Enable Cloudflare Pages (#1100) 2022-04-24 13:12:18 -05:00
Pipfile.lock Enable Cloudflare Pages (#1100) 2022-04-24 13:12:18 -05:00
README.md Enable Cloudflare Pages (#1100) 2022-04-24 13:12:18 -05:00

Privacy Guides Privacy Guides

Your central privacy and security resource to protect yourself online.


Privacy Guides is a socially motivated website that provides information for protecting your data security and privacy. We are a non-profit collective operated entirely by volunteer team members and contributors.

Our current list of team members can be found here. Additionally, many people have made contributions to the project, and you can too!



  1. Clone this repository and submodules: git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org
  2. Install Python 3.6+
  3. Install pipenv: pip install pipenv
  4. Start a pipenv shell: pipenv shell
  5. Install dependencies: pipenv install --dev
  6. Serve the site locally: mkdocs serve
    • The site will be available at http://localhost:8000
    • You can build the site locally with mkdocs build
    • This version of the site should be identical to the live, production version


  1. Create a new tag: git tag -s v2.X.X -m 'Some message'
    • View existing tags
    • Tag numbering: Increment the MINOR (2nd) number when making significant changes (adding/deleting pages, etc.), increment the PATCH (3rd) number when making minor changes (typos, bug fixes). Probably leave the MAJOR number at 2 until a massive redesign (v1 -> v2 was the Jekyll to MkDocs transition).
  2. Push the tag to GitHub: git push --tags
  3. Create a new release selecting the new tag
    • Title the release the same as the tag version number without the v, i.e. 2.X.X
    • GitHub should let you auto-generate release notes based on PR titles
      • Mark more significant changes in bold, see 2.3.0 for example
  4. Publish release, it will be deployed to the live site automatically
    • When publishing more significant releases (generally any with a MINOR version increment) check the "Create a discussion for this release" box to post an announcement