|
37 | 37 | </a></p>
|
38 | 38 | </div>
|
39 | 39 |
|
| 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 | + |
40 | 55 | ## Developing
|
41 | 56 |
|
42 | 57 | 1. Clone this repository: `git clone https://github.com/privacyguides/privacyguides.org`
|
43 | 58 | 2. Install [Python 3.6+](https://www.python.org/downloads/)
|
44 | 59 | 3. Install [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material`
|
45 | 60 | 4. Serve the site locally: `mkdocs serve`
|
46 | 61 | - 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