~jonaharagon/privacyguides

Privacy Guides is your central privacy and security resource to protect yourself online.

9c85a65 Improve Cryptee card (#1814)

11 hours ago

23a2419 PrivacyTools FAQ (#1808)

18 hours ago
Privacy Guides

Your central privacy and security resource to protect yourself online.

#About

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!

#Contributing

#Mirrors

GitHub Gitea GitLab Codeberg SourceHut

#Developing

Committing to this repository requires signing your 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, but GPG signing is also acceptable. You should add your signing key to your GitHub profile.

This website uses 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+ (currently only tested with 3.10)
  3. Install dependencies: 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.

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

  1. Clone this repository and submodules: git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org.git
  2. Enable SSH commit verification with our local .allowed_signers file: git config gpg.ssh.allowedSignersFile .allowed_signers
  3. Install Python 3.10
  4. Install pipenv: pip install pipenv
  5. Install dependencies: pipenv install --dev (install Pillow and CairoSVG 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)
    • The site will be available at http://localhost:8000
    • You can build the site locally with pipenv run mkdocs build
    • 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 in this repo.

#Releasing

  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 revamp (v1 -> v2 was the Jekyll to MkDocs transition).
    • Consider enabling GPG tag signing by default (git config tag.gpgSign true) to avoid missing signatures
  2. Push the tag to GitHub: git push --tags
  3. A GitHub Release will be automatically created and deployed to the live site.
    • You may wish to manually check or edit the release changelog/title after it is published for accuracy.