Git-Mirrors/privacyguides.org
1
0
Fork 0
mirror of https://github.com/privacyguides/privacyguides.org.git synced 2024-12-23 22:49:42 -05:00
Code Issues Packages Projects Releases Wiki Activity
Protect your data against global mass surveillance programs.
2,828 Commits 40 Branches 146 Tags 114 MiB
Markdown 93.6%
HTML 3.5%
CSS 1.9%
Shell 0.5%
JavaScript 0.3%
Other 0.2%
f255d49760
Go to file
Jonah Aragon f255d49760
Create release workflow (#1693)
2022-08-24 20:24:49 -05:00
.github Create release workflow (#1693) 2022-08-24 20:24:49 -05:00
.well-known Pull Matrix server configuration (#1656) 2022-08-18 11:46:56 -05:00
docs Replace Scrambled Exif with ExifEraser (#1687) 2022-08-23 13:51:18 -05:00
includes Add Signal Configuration and Molly Knowledge Base article (#1494) 2022-07-07 23:07:24 +09:30
mkdocs-material@2b4e34c0dc Update mkdocs-material-insiders (#1657) 2022-08-18 19:02:48 -05:00
theme Add spacing between buttons on mobile (#1648) 2022-08-17 13:38:35 +09:30
.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 Remove blog submodule 2022-08-10 19:50:03 -05:00
.markdownlint.yml Listing common threat examples (#1276) 2022-05-21 16:55:14 -05:00
CITATION.cff Create CITATION.cff 2022-08-18 18:32:20 -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.production.yml Enable social cards (#1691) 2022-08-24 20:18:26 -05:00
mkdocs.yml Enable social cards (#1691) 2022-08-24 20:18:26 -05:00
Pipfile Enable social cards (#1691) 2022-08-24 20:18:26 -05:00
Pipfile.lock Enable social cards (#1691) 2022-08-24 20:18:26 -05:00
README.md Create release workflow (#1693) 2022-08-24 20:24:49 -05:00

README.md

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

Blog

We aspire to publish the best articles about privacy on the net. From hot-takes to long-form essays, we are looking for stylish and well-written pieces.

This not a place for sponsored content or SEO-obsessed posts. Please do not pitch us this, as we don't take kindly to it and your email will be blocked. Caveat scriptor.

Submit stories or requests to: freddy@privacyguides.org

Mirrors

GitHub Gitea GitLab Codeberg

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 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).
  2. Push the tag to GitHub: git push --tags
  3. A draft release will be created on GitHub. Publish the release and 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