Skip to content

Commit fdc7357

Browse files
authored
Merge branch 'main' into main
Signed-off-by: titanism <[email protected]>
2 parents 7d834cf + 116e31b commit fdc7357

File tree

269 files changed

+13253
-9980
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+13253
-9980
lines changed

.all-contributorsrc

+2,862
Large diffs are not rendered by default.

.cache/plugin/social/fonts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../theme/assets/brand/fonts

.cache/plugin/social/fonts/Bagnard/Bold.woff

-1
This file was deleted.

.devcontainer/devcontainer.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/python
3+
{
4+
"name": "Privacy Guides",
5+
"image": "ghcr.io/squidfunk/mkdocs-material:9.5.17",
6+
"forwardPorts": [8000],
7+
"postCreateCommand": "git submodule init; git submodule update theme/assets/brand; apk add bash; /bin/bash run.sh --cmd=mkdocs --cmd_flags=--dev-addr=0.0.0.0:8000"
8+
}

.devcontainer/team/devcontainer.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/python
3+
{
4+
"name": "Privacy Guides Team",
5+
"image": "ghcr.io/privacyguides/privacyguides.org:main",
6+
"forwardPorts": [8000],
7+
"postCreateCommand": "git submodule init; git submodule update theme/assets/brand; ./run.sh --cmd=mkdocs --insiders --production --cmd_flags=--dev-addr=0.0.0.0:8000"
8+
}

.editorconfig

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Copyright (c) 2024 Jonah Aragon <[email protected]>
2+
3+
# Permission is hereby granted, free of charge, to any person obtaining a copy
4+
# of this software and associated documentation files (the "Software"), to
5+
# deal in the Software without restriction, including without limitation the
6+
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7+
# sell copies of the Software, and to permit persons to whom the Software is
8+
# furnished to do so, subject to the following conditions:
9+
10+
# The above copyright notice and this permission notice shall be included in
11+
# all copies or substantial portions of the Software.
12+
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
16+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18+
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19+
# IN THE SOFTWARE.
20+
21+
# EditorConfig is awesome: https://EditorConfig.org
22+
23+
# top-most EditorConfig file
24+
root = true
25+
26+
# Unix-style newlines with a newline ending every file
27+
[*]
28+
charset = utf-8
29+
indent_style = space
30+
indent_size = 2
31+
end_of_line = lf
32+
insert_final_newline = true
33+
trim_trailing_whitespace = true
34+
35+
[{*.caddy,*.example-caddy,Caddyfile}]
36+
charset = utf-8
37+
indent_style = tab
38+
tab_width = 4

.github/CODEOWNERS

+1-24
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,5 @@
1-
# Copyright (c) 2019-2023 Jonah Aragon <[email protected]>
2-
3-
# Permission is hereby granted, free of charge, to any person obtaining a copy
4-
# of this software and associated documentation files (the "Software"), to
5-
# deal in the Software without restriction, including without limitation the
6-
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7-
# sell copies of the Software, and to permit persons to whom the Software is
8-
# furnished to do so, subject to the following conditions:
9-
10-
# The above copyright notice and this permission notice shall be included in
11-
# all copies or substantial portions of the Software.
12-
13-
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14-
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15-
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
16-
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17-
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18-
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19-
# IN THE SOFTWARE.
20-
21-
# Additional Co-Owners are added to the TOP of this file
22-
231
# High-traffic pages
24-
/docs/index.en.md @jonaharagon @dngray
2+
/docs/index.md @jonaharagon @dngray
253
/theme/overrides/ @jonaharagon
264

275
# Org
@@ -35,4 +13,3 @@ README.md @jonaharagon @dngray
3513
/Pipfile @jonaharagon
3614
/Pipfile.lock @jonaharagon
3715
/.github/ @jonaharagon
38-
/.well-known/ @jonaharagon

.github/ISSUE_TEMPLATE/1_Content_Correction.yml

+5-6
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,17 @@ name: "Content Correction"
2222
description: Report any inaccurate, incorrect, or outdated information on the website.
2323
labels: ["t:correction"]
2424
body:
25-
2625
- type: markdown
2726
attributes:
2827
value: |
29-
This form is for reporting verifiable issues with our website.
30-
If you simply disagree with an opinion on the website, please open a discussion [on our forum](https://discuss.privacyguides.net/) instead.
31-
28+
This form is for reporting verifiable issues with our website.
29+
If you simply disagree with an opinion on the website, please open a discussion [on our forum](https://discuss.privacyguides.net) instead.
30+
3231
- type: input
3332
attributes:
3433
label: Affected page
3534
description: Please let us know which page the incorrect information can be found on.
36-
placeholder: "https://www.privacyguides.org/en/data-redaction/"
35+
placeholder: "https://www.privacyguides.org/en/data-redaction"
3736
validations:
3837
required: true
3938

@@ -62,5 +61,5 @@ body:
6261
options:
6362
- label: I am reporting something that is verifiably incorrect, not a suggestion or opinion.
6463
required: true
65-
- label: I agree to the [Community Code of Conduct](https://www.privacyguides.org/en/code_of_conduct/).
64+
- label: I agree to the [Community Code of Conduct](https://www.privacyguides.org/coc).
6665
required: true

.github/ISSUE_TEMPLATE/2_Website_Issues.yml

+7-8
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,22 @@ labels: ["t:bug"]
2424
assignees:
2525
- jonaharagon
2626
body:
27-
2827
- type: markdown
2928
attributes:
3029
value: |
3130
This form is only for reporting a technical bug __with our website__, like broken images, broken CSS, issues with search or themes, etc.
3231
This is not the place to report an issue with Matrix, Discourse, or our other hosted services.
3332
3433
If you want us to fix inaccurate information on the website, go back and use the content correction form.
35-
If you want to make another suggestion, please [use our discussion forum](https://discuss.privacyguides.net/) instead.
36-
34+
If you want to make another suggestion, please [use our discussion forum](https://discuss.privacyguides.net) instead.
35+
3736
- type: textarea
3837
id: description
3938
attributes:
4039
label: Bug description
4140
description: |
42-
Please give a detailed description of the bug.
43-
Explain how the website does not behave as you would expect it to, and be as specific as possible.
41+
Please give a detailed description of the bug.
42+
Explain how the website does not behave as you would expect it to, and be as specific as possible.
4443
If you have found a workaround or a fix for the problem too, please let us know.
4544
validations:
4645
required: true
@@ -53,7 +52,7 @@ body:
5352
Please list all pages where you've noticed this issue, or let us know if it affects every page on the site.
5453
value: |
5554
-
56-
55+
5756
- type: dropdown
5857
id: browser
5958
attributes:
@@ -69,7 +68,7 @@ body:
6968
- Safari
7069
- Edge
7170
- Other
72-
71+
7372
- type: dropdown
7473
id: os
7574
attributes:
@@ -93,7 +92,7 @@ body:
9392
options:
9493
- label: I am reporting something that is broken on the website, not making a suggestion.
9594
required: true
96-
- label: I agree to the [Community Code of Conduct](https://www.privacyguides.org/en/code_of_conduct/).
95+
- label: I agree to the [Community Code of Conduct](https://www.privacyguides.org/coc).
9796
required: true
9897

9998
- type: markdown

.github/PULL_REQUEST_TEMPLATE.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Changes proposed in this PR:
22

3-
-
3+
-
44

55
<!-- SCROLL TO BOTTOM TO AGREE!:
66
Please use a descriptive title for your PR, it will be included in our changelog!
@@ -13,11 +13,16 @@ family, friends, clients, employers, or your financial and other relationships.
1313
Any external relationship can trigger a conflict of interest.
1414
-->
1515

16-
<!-- Place an x in the boxes below, like: [x] -->
17-
- [ ] I have disclosed any relevant conflicts of interest in my post.
18-
- [ ] I agree to grant Privacy Guides a perpetual, worldwide, non-exclusive, transferable, royalty-free, irrevocable license with the right to sublicense such rights through multiple tiers of sublicensees, to reproduce, modify, display, perform, relicense, and distribute my contribution as part of this project.
19-
- [ ] I am the sole author of this work. <!-- Do not check this box if you are not -->
20-
- [ ] I agree to the [Community Code of Conduct](https://www.privacyguides.org/en/code_of_conduct/).
16+
<summary>
17+
18+
<!-- To agree, place an x in the box below, like: [x] -->
19+
- [ ] I agree to the terms listed below:
20+
<details><summary>Contribution terms (click to expand)</summary>
21+
1) I am the sole author of this work.
22+
2) I agree to grant Privacy Guides a perpetual, worldwide, non-exclusive, transferable, royalty-free, irrevocable license with the right to sublicense such rights through multiple tiers of sublicensees, to reproduce, modify, display, perform, relicense, and distribute my contribution as part of this project.
23+
3) I have disclosed any relevant conflicts of interest in my post.
24+
4) I agree to the Community Code of Conduct.
25+
</details>
2126

2227
<!-- What's this? When you submit a PR, you keep the Copyright for the work you
2328
are contributing. We need you to agree to the above terms in order for us to

.github/dependabot.yml

+12-5
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,44 @@
2121
version: 2
2222

2323
registries:
24-
2524
github-privacyguides:
2625
type: git
2726
url: https://github.com
2827
username: x-access-token
2928
password: ${{secrets.REPO_PAT}}
3029

3130
updates:
32-
3331
# Maintain dependencies for GitHub Actions
3432
- package-ecosystem: "github-actions"
3533
directory: "/"
3634
schedule:
37-
interval: "daily"
35+
interval: "monthly"
3836
assignees:
3937
- "jonaharagon"
4038
reviewers:
4139
- "jonaharagon"
4240
labels:
4341
- "fix:github_actions"
44-
42+
4543
# Maintain submodules
4644
- package-ecosystem: "gitsubmodule"
4745
directory: "/"
4846
registries:
4947
- github-privacyguides
5048
schedule:
51-
interval: "daily"
49+
interval: "monthly"
5250
labels:
5351
- "fix:submodules"
5452

53+
- package-ecosystem: "devcontainers"
54+
directory: "/"
55+
schedule:
56+
interval: weekly
57+
58+
- package-ecosystem: "docker"
59+
directory: "/"
60+
schedule:
61+
interval: weekly
5562
# Disabled because some updates tend to remove needed dependencies for some reason
5663

5764
# # Maintain dependencies for pipenv

.github/workflows/build-container.yml

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: ☁️ Build Container
2+
3+
# Configures this workflow to run every time a change is pushed to the branch called `release`.
4+
on:
5+
push:
6+
branches: ["main"]
7+
release:
8+
types: [published]
9+
workflow_dispatch:
10+
11+
concurrency:
12+
group: container-build
13+
cancel-in-progress: true
14+
15+
permissions:
16+
contents: read
17+
packages: write
18+
19+
# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
20+
env:
21+
REGISTRY: ghcr.io
22+
IMAGE_NAME: ${{ github.repository }}
23+
24+
# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
25+
jobs:
26+
submodule:
27+
strategy:
28+
matrix:
29+
repo: [mkdocs-material-insiders, brand]
30+
uses: privacyguides/.github/.github/workflows/download-repo.yml@main
31+
with:
32+
repo: ${{ matrix.repo }}
33+
secrets:
34+
ACTIONS_SSH_KEY: ${{ secrets.ACTIONS_SSH_KEY }}
35+
36+
build-and-push-image:
37+
needs: submodule
38+
runs-on: ubuntu-latest
39+
steps:
40+
- name: Checkout repository
41+
uses: actions/checkout@v4
42+
with:
43+
fetch-depth: 0
44+
45+
- uses: actions/download-artifact@v4
46+
with:
47+
pattern: repo-*
48+
path: modules
49+
50+
- run: |
51+
rm -rf modules/mkdocs-material
52+
mv modules/repo-mkdocs-material-insiders modules/mkdocs-material
53+
rm -rf theme/assets/brand
54+
mv modules/repo-brand theme/assets/brand
55+
56+
# Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
57+
- name: Log in to the Container registry
58+
uses: docker/[email protected]
59+
with:
60+
registry: ${{ env.REGISTRY }}
61+
username: ${{ github.actor }}
62+
password: ${{ secrets.GITHUB_TOKEN }}
63+
64+
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
65+
- name: Extract metadata (tags, labels) for Docker
66+
id: meta
67+
uses: docker/[email protected]
68+
with:
69+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
70+
tags: |
71+
type=ref,event=branch
72+
type=ref,event=tag
73+
type=ref,event=pr
74+
type=sha
75+
flavor: |
76+
latest=${{ github.event_name == 'release' }}
77+
78+
# This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
79+
# It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
80+
# It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
81+
- name: Build and push Docker image
82+
uses: docker/[email protected]
83+
with:
84+
context: .
85+
push: true
86+
tags: ${{ steps.meta.outputs.tags }}
87+
labels: ${{ steps.meta.outputs.labels }}
88+
89+
cleanup:
90+
if: ${{ always() }}
91+
needs: build-and-push-image
92+
uses: privacyguides/.github/.github/workflows/cleanup.yml@main

0 commit comments

Comments
 (0)