Git-Mirrors/privacyguides.org
1
0
Fork 0
mirror of https://github.com/privacyguides/privacyguides.org.git synced 2024-10-01 01:35:57 -04:00
Code Issues Packages Projects Releases Wiki Activity
Protect your data against global mass surveillance programs.
2,486 Commits 44 Branches 138 Tags 110 MiB
Markdown 93.1%
HTML 3.7%
CSS 2%
JavaScript 0.7%
Shell 0.3%
Other 0.2%
84b507b2ae
Go to file
Daniel Nathan Gray 84b507b2ae
Mention OpenQA (#1033)
2022-04-16 07:47:55 +00:00
.github Add manual deployment trigger 2022-04-14 10:09:08 -05:00
.well-known Clean up the cruft 2021-01-15 23:46:23 -06:00
docs Mention OpenQA (#1033) 2022-04-16 07:47:55 +00:00
mkdocs-material@f02ab2a15e Netlify PR Previews (#915) 2022-04-05 12:29:24 -05:00
theme Remove CHANGELOG.md (#1011) 2022-04-14 00:38:37 +00: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 Support asset localization (#1027) 2022-04-15 15:30:56 +09:30
LICENSE Proper Content Licensing 2021-09-16 09:57:21 -05:00
mkdocs.yml Add support for localization (#995) 2022-04-13 19:19:13 -05:00
Pipfile Add support for localization (#995) 2022-04-13 19:19:13 -05:00
Pipfile.lock Add support for localization (#995) 2022-04-13 19:19:13 -05:00
README.md Update contribution instructions 2022-04-13 20:42:43 -05:00

README.md

Privacy Guides 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

Developing

  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 --config-file mkdocs.production.yml
    • The site will be available at http://localhost:8000
    • You can build the site locally with mkdocs build --config-file mkdocs.production.yml
    • This version of the site should be identical to the live, production version

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 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