Skip to content

Commit 4ae2e94

Browse files
authored
Add changelog, deploy on tagged releases (#987)
1 parent 834d30a commit 4ae2e94

File tree

4 files changed

+50
-15
lines changed

4 files changed

+50
-15
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,13 @@
11
# Additional Co-Owners are added to the TOP of this file.
22

33
# High-traffic pages
4-
/index.html @JonahAragon @dngray
5-
/blog.html @JonahAragon
4+
/docs/index.md @JonahAragon @dngray
5+
/theme/overrides/ @JonahAragon
66

7-
# Org/legal
8-
/notices.md @JonahAragon
9-
/privacy-policy.md @JonahAragon
7+
# Org
8+
/docs/about/ @JonahAragon
109
LICENSE @JonahAragon
1110

12-
# Website dev
13-
/_sass/ @JonahAragon
14-
/_layouts/ @JonahAragon
15-
Gemfile @JonahAragon
16-
Gemfile.lock @JonahAragon
17-
_config.yml @JonahAragon
18-
1911
# Ops
2012
/.github/ @JonahAragon
2113
/.well-known/ @JonahAragon

.github/workflows/deploy.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
name: Deploy Website
22
on:
3-
push:
4-
branches:
5-
- main
3+
release:
4+
types: [published]
65

76
env:
87
PYTHON_VERSION: 3.x

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Privacy Guides Changelog
2+
3+
<!-- Add the date and any new changes to the TOP of this file, below this line. -->
4+
5+
## 2022-04-11
6+
7+
- Added changelog
8+
- Switched to release-based deployments ([#987](https://github.com/privacyguides/privacyguides.org/pull/987))
9+
- Removed blog from repo, moved to [blog.privacyguides.org](https://blog.privacyguides.org) ([#985](https://github.com/privacyguides/privacyguides.org/pull/985))
10+
- Add RSS page ([#895](https://github.com/privacyguides/privacyguides.org/pull/895/))
11+
- MFA/YubiKey clarifications ([#972](https://github.com/privacyguides/privacyguides.org/pull/972))
12+
13+
---
14+
15+
*Massive thanks to [u/SnowCatFalcon](https://www.reddit.com/user/SnowCatFalcon/) for publishing [changelogs on our Subreddit](https://www.reddit.com/r/PrivacyGuides/comments/tu2dvw/privacy_guides_changelogs_march_2022/) before we added this file.*

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,39 @@
3737
</a></p>
3838
</div>
3939

40+
## About
41+
42+
**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.
43+
44+
Our current list of team members can be found [here](https://github.com/orgs/privacyguides/people). Additionally, [many people](https://github.com/privacyguides/privacyguides.org/graphs/contributors) have made contributions to the project, and you can too!
45+
46+
## Contributing
47+
48+
- 💬 [Start a discussion or suggest an idea](https://github.com/privacyguides/privacyguides.org/discussions)
49+
- 💖 [Sponsor the project](https://github.com/sponsors/privacyguides)
50+
- 📝 Edit the site, everything's accessible in this repo
51+
- Browse our [open issues](https://github.com/privacyguides/privacyguides.org/issues) to see what needs to be updated
52+
- When making more significant (than simple typo fixes, etc.) changes, update the [changelog](/CHANGELOG.md)
53+
- View some contribution tips on our [contributor's wiki](https://github.com/privacyguides/privacyguides.org/wiki)
54+
4055
## Developing
4156

4257
1. Clone this repository: `git clone https://github.com/privacyguides/privacyguides.org`
4358
2. Install [Python 3.6+](https://www.python.org/downloads/)
4459
3. Install [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material`
4560
4. Serve the site locally: `mkdocs serve`
4661
- The site will be available at `http://localhost:8000/`.
62+
63+
Your local site will appear slightly different, because the production version of the website uses a private/custom build of mkdocs-material with additional features.
64+
65+
Team members with access to [mkdocs-material-insiders](https://github.com/privacyguides/mkdocs-material-insiders) should instead:
66+
67+
1. Clone this repository and submodules: `git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org`
68+
2. Install [Python 3.6+](https://www.python.org/downloads/)
69+
3. Install **pipenv**: `pip install pipenv`
70+
4. Start a pipenv shell: `pipenv shell`
71+
5. Install dependencies: `pipenv install --dev`
72+
6. Serve the site locally: `mkdocs serve --config-file mkdocs.production.yml`
73+
- The site will be available at `http://localhost:8000`
74+
- You can build the site locally with `mkdocs build --config-file mkdocs.production.yml`
75+
- This version of the site should be identical to the live, production version

0 commit comments

Comments
 (0)