Git-Mirrors/privacyguides.org
1
0
Fork 0
mirror of https://github.com/privacyguides/privacyguides.org.git synced 2025-05-02 06:16:27 -04:00
Code Issues Projects Releases Packages Wiki Activity

feat: Ensure all pages have proper descriptions (#2752)

Browse source 
Signed-off-by: blacklight447 <niek@privacyguides.org>
Signed-off-by: kimg45 <138676274+kimg45@users.noreply.github.com>
Signed-off-by: Daniel Gray <dngray@privacyguides.org>
This commit is contained in:
Jonah Aragon 2024-09-22 08:27:17 +00:00 • committed by Daniel Gray
parent ec0701bfa8
commit 4bd9c6ca20
No known key found for this signature in database
GPG key ID: 41911F722B0F9AE3
79 changed files with 315 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/meta/admonitions.md
View file

@ -1,5 +1,6 @@
---
title: Admonitions
description: A guide for website contributors on creating admonitions.
---
**Admonitions** (or "call-outs") are a choice writers can use to include side content in an article without interrupting the document flow.

1
docs/meta/brand.md
View file

@ -1,5 +1,6 @@
---
title: Branding Guidelines
description: A guide for journalists and website contributors on proper branding of the Privacy Guides wordmark and logo.
---
The name of the website is **Privacy Guides** and should **not** be changed to:

1
docs/meta/commit-messages.md
View file

@ -1,5 +1,6 @@
---
title: Commit Messages
description: A guide for website contributors on using useful Git commit messages when making website change requests.
---
For our commit messages we follow the style provided by [Conventional Commits](https://conventionalcommits.org). Not all of those suggestions are appropriate for Privacy Guides, so the main ones we use are:

1
docs/meta/git-recommendations.md
View file

@ -1,5 +1,6 @@
---
title: Git Recommendations
description: A guide for website contributors on using Git effectively.
---
If you make changes to this website on GitHub.com's web editor directly, you shouldn't have to worry about this. If you are developing locally and/or are a long-term website editor (who should probably be developing locally!), consider these recommendations.

1
docs/meta/translations.md
View file

@ -1,5 +1,6 @@
---
title: Translations
description: A guide for website contributors on adding translations to our website.
---
Crowdin has good documentation, and we suggest looking at their [Getting Started](https://support.crowdin.com/crowdin-intro) guide. Our site is largely written in [Markdown](https://en.wikipedia.org/wiki/Markdown), so it should be easy to contribute. This page contains some helpful pointers for translating some specific syntax you may encounter on our site.

1
docs/meta/uploading-images.md
View file

@ -1,5 +1,6 @@
---
title: Uploading Images
description: A guide for website contributors on uploading images in the proper format and location.
---
If you make changes to this website that involve adding new images or replacing existing ones, here are a couple of general recommendations:

1
docs/meta/writing-style.md
View file

@ -1,5 +1,6 @@
---
title: Writing Style
description: Our official writing style handbook for website contributors.
---
Privacy Guides is written in American English, and you should refer to [APA Style guidelines](https://apastyle.apa.org/style-grammar-guidelines/grammar) when in doubt.