c638491 Mention Proton's letter of attestation
~jonaharagon-bot pushed to ~jonaharagon/privacyguides.org git
d1b2bc7 Fix typo Qubes OS overview
~jonaharagon-bot pushed to ~jonaharagon/privacyguides.org git
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!
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
:
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
pip install mkdocs mkdocs-material mkdocs-static-i18n mkdocs-macros-plugin typing-extensions
mkdocs serve
http://localhost:8000
mkdocs build
Team members should clone the repository with mkdocs-material-insiders
directly. This method is identical to production:
git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org.git
.allowed_signers
file: git config gpg.ssh.allowedSignersFile .allowed_signers
pip install pipenv
pipenv install --dev
(install Pillow and CairoSVG as well to generate social cards)pipenv run mkdocs serve --config-file mkdocs.production.yml
(set CARDS=true
to generate social cards)
http://localhost:8000
pipenv run mkdocs build
If you commit to main
with commits signed with your SSH key, you should add your SSH key to .allowed_signers
in this repo.
git tag -s v2.X.X -m 'Some message'
git config tag.gpgSign true
) to avoid missing signaturesgit push --tags