mirror of
				https://github.com/privacyguides/privacyguides.org.git
				synced 2025-10-31 19:46:34 +00:00 
			
		
		
		
	Add changelog, deploy on tagged releases (#987)
This commit is contained in:
		
							
								
								
									
										16
									
								
								.github/CODEOWNERS
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										16
									
								
								.github/CODEOWNERS
									
									
									
									
										vendored
									
									
								
							| @@ -1,21 +1,13 @@ | |||||||
| # Additional Co-Owners are added to the TOP of this file. | # Additional Co-Owners are added to the TOP of this file. | ||||||
|  |  | ||||||
| # High-traffic pages | # High-traffic pages | ||||||
| /index.html @JonahAragon @dngray | /docs/index.md @JonahAragon @dngray | ||||||
| /blog.html @JonahAragon | /theme/overrides/ @JonahAragon | ||||||
|  |  | ||||||
| # Org/legal | # Org | ||||||
| /notices.md @JonahAragon | /docs/about/ @JonahAragon | ||||||
| /privacy-policy.md @JonahAragon |  | ||||||
| LICENSE @JonahAragon | LICENSE @JonahAragon | ||||||
|  |  | ||||||
| # Website dev |  | ||||||
| /_sass/ @JonahAragon |  | ||||||
| /_layouts/ @JonahAragon |  | ||||||
| Gemfile @JonahAragon |  | ||||||
| Gemfile.lock @JonahAragon |  | ||||||
| _config.yml @JonahAragon |  | ||||||
|  |  | ||||||
| # Ops | # Ops | ||||||
| /.github/ @JonahAragon | /.github/ @JonahAragon | ||||||
| /.well-known/ @JonahAragon | /.well-known/ @JonahAragon | ||||||
|   | |||||||
							
								
								
									
										5
									
								
								.github/workflows/deploy.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.github/workflows/deploy.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,7 @@ | |||||||
| name: Deploy Website | name: Deploy Website | ||||||
| on: | on: | ||||||
|   push: |   release: | ||||||
|     branches: |     types: [published] | ||||||
|       - main |  | ||||||
|  |  | ||||||
| env: | env: | ||||||
|   PYTHON_VERSION: 3.x |   PYTHON_VERSION: 3.x | ||||||
|   | |||||||
							
								
								
									
										15
									
								
								CHANGELOG.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								CHANGELOG.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,15 @@ | |||||||
|  | # Privacy Guides Changelog | ||||||
|  |  | ||||||
|  | <!-- Add the date and any new changes to the TOP of this file, below this line. --> | ||||||
|  |  | ||||||
|  | ## 2022-04-11 | ||||||
|  |  | ||||||
|  | - Added changelog | ||||||
|  | - Switched to release-based deployments ([#987](https://github.com/privacyguides/privacyguides.org/pull/987)) | ||||||
|  | - Removed blog from repo, moved to [blog.privacyguides.org](https://blog.privacyguides.org) ([#985](https://github.com/privacyguides/privacyguides.org/pull/985)) | ||||||
|  | - Add RSS page ([#895](https://github.com/privacyguides/privacyguides.org/pull/895/)) | ||||||
|  | - MFA/YubiKey clarifications ([#972](https://github.com/privacyguides/privacyguides.org/pull/972)) | ||||||
|  |  | ||||||
|  | --- | ||||||
|  |  | ||||||
|  | *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.* | ||||||
							
								
								
									
										29
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										29
									
								
								README.md
									
									
									
									
									
								
							| @@ -37,6 +37,21 @@ | |||||||
|   </a></p> |   </a></p> | ||||||
| </div> | </div> | ||||||
|  |  | ||||||
|  | ## 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](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! | ||||||
|  |  | ||||||
|  | ## Contributing | ||||||
|  |  | ||||||
|  | - 💬 [Start a discussion or suggest an idea](https://github.com/privacyguides/privacyguides.org/discussions) | ||||||
|  | - 💖 [Sponsor the project](https://github.com/sponsors/privacyguides) | ||||||
|  | - 📝 Edit the site, everything's accessible in this repo | ||||||
|  |   - Browse our [open issues](https://github.com/privacyguides/privacyguides.org/issues) to see what needs to be updated | ||||||
|  |   - When making more significant (than simple typo fixes, etc.) changes, update the [changelog](/CHANGELOG.md) | ||||||
|  |   - View some contribution tips on our [contributor's wiki](https://github.com/privacyguides/privacyguides.org/wiki) | ||||||
|  |  | ||||||
| ## Developing | ## Developing | ||||||
|  |  | ||||||
| 1. Clone this repository: `git clone https://github.com/privacyguides/privacyguides.org` | 1. Clone this repository: `git clone https://github.com/privacyguides/privacyguides.org` | ||||||
| @@ -44,3 +59,17 @@ | |||||||
| 3. Install [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material` | 3. Install [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material` | ||||||
| 4. Serve the site locally: `mkdocs serve` | 4. Serve the site locally: `mkdocs serve` | ||||||
|     - The site will be available at `http://localhost:8000/`. |     - The site will be available at `http://localhost:8000/`. | ||||||
|  |    | ||||||
|  | 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. | ||||||
|  |  | ||||||
|  | Team members with access to [mkdocs-material-insiders](https://github.com/privacyguides/mkdocs-material-insiders) should instead: | ||||||
|  |  | ||||||
|  | 1. Clone this repository and submodules: `git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org` | ||||||
|  | 2. Install [Python 3.6+](https://www.python.org/downloads/) | ||||||
|  | 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 | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 GitHub
						GitHub