Skip to content

Commit f89c5c4

Browse files
committed
Fix typos, add documentation files, and improve SEO/security
- Fix typos: Browse -> browsing, GitHub capitalization, missing quote - Add LICENSE file with CC BY-NC 4.0 license - Add CONTRIBUTING.md with contribution guidelines - Add CODE_OF_CONDUCT.md for community standards - Security: Fix font preload CORS (crossorigin: 'anonymous') - SEO: Add canonical URL and og:type meta tags - SEO: Use absolute URLs for Open Graph and Twitter Card images
1 parent 9d2dc43 commit f89c5c4

8 files changed

Lines changed: 419 additions & 12 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
The Privacy Activist Kit is committed to providing a safe and welcoming environment for everyone who wants to learn about and contribute to digital privacy and security. We expect all community members to treat each other with respect and dignity.
6+
7+
## Our Values
8+
9+
This project exists to empower people to protect their digital rights and privacy. We believe that:
10+
11+
- **Privacy is a human right** that should be accessible to everyone
12+
- **Collaboration works best** when everyone feels safe to contribute, ask questions, and share knowledge
13+
- **Respect is fundamental** to building trust and creating meaningful change
14+
15+
## Expected Behavior
16+
17+
We expect all community members, contributors, and maintainers to:
18+
19+
- **Be respectful and considerate** in all interactions
20+
- **Be patient with beginners** and remember that everyone started somewhere
21+
- **Give and receive constructive feedback** gracefully and with good intent
22+
- **Focus on what is best for the community** and the project's mission
23+
- **Respect different threat models and privacy needs** without judgment
24+
- **Maintain confidentiality** when discussing sensitive security topics
25+
- **Credit the work of others** and respect intellectual property
26+
27+
## Unacceptable Behavior
28+
29+
The following behaviors are unacceptable in our community:
30+
31+
- **Harassment or discrimination** of any kind
32+
- **Trolling, insulting comments, or personal attacks**
33+
- **Publishing others' private information** without explicit permission (doxing)
34+
- **Deliberate intimidation, stalking, or following**
35+
- **Advocating for or encouraging** any of the above behaviors
36+
- **Promoting malicious hacking** or offensive security tactics that could harm others
37+
- **Sharing exploits or vulnerabilities** in ways that put people at risk
38+
- **Disrupting discussions** or derailing conversations
39+
- **Other conduct** that could reasonably be considered inappropriate in a professional or community setting
40+
41+
## Scope
42+
43+
This Code of Conduct applies to all project spaces, including:
44+
45+
- GitHub repositories (issues, pull requests, discussions, code)
46+
- Project documentation and website content
47+
- Community forums and communication channels
48+
- Events or meetups representing the project
49+
- Social media accounts associated with the project
50+
51+
This Code of Conduct also applies when an individual is representing the project in public spaces.
52+
53+
## Privacy and Security Considerations
54+
55+
Given the nature of this project, we have additional guidelines:
56+
57+
- **Don't share sensitive personal information** in public spaces (issues, pull requests, etc.)
58+
- **Report security vulnerabilities privately** before disclosing them publicly
59+
- **Be mindful of operational security** when discussing activist work or threat models
60+
- **Respect that people have different levels of risk** and different privacy needs
61+
- **Don't pressure anyone to share** their personal threat model, location, identity, or affiliations
62+
63+
## Enforcement
64+
65+
### Reporting
66+
67+
If you experience or witness unacceptable behavior, or have any other concerns, please report it by:
68+
69+
- Opening a private issue to the project maintainers (if available)
70+
- Contacting the maintainers through the project's designated reporting channels
71+
- Reaching out through GitHub's reporting features for serious violations
72+
73+
All reports will be handled with discretion and confidentiality.
74+
75+
### Response
76+
77+
Project maintainers are responsible for clarifying and enforcing this Code of Conduct. They will:
78+
79+
- Review all reports fairly and promptly
80+
- Respect the privacy and security of the reporter
81+
- Take appropriate action in response to violations
82+
83+
### Consequences
84+
85+
Community members who violate this Code of Conduct may face consequences including:
86+
87+
1. **Warning**: A private, written warning explaining the violation and expected behavior going forward
88+
2. **Temporary Ban**: A temporary ban from interacting with the project for a specified period
89+
3. **Permanent Ban**: A permanent ban from the community and project spaces
90+
91+
The severity of the consequence will depend on the nature and frequency of the violation.
92+
93+
## Attribution
94+
95+
This Code of Conduct is adapted from:
96+
- [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
97+
- [Citizen Code of Conduct](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md)
98+
99+
## Questions
100+
101+
If you have questions about this Code of Conduct, please:
102+
- Open an issue for public discussion of policy clarifications
103+
- Contact the maintainers privately for sensitive questions
104+
105+
## Changes
106+
107+
This Code of Conduct may be updated from time to time. Community members are encouraged to check back periodically. Significant changes will be announced through project communication channels.
108+
109+
---
110+
111+
**Last Updated**: January 2025
112+
113+
By participating in this project, you agree to abide by this Code of Conduct.

CONTRIBUTING.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributing to Privacy Activist Kit
2+
3+
Thank you for considering contributing to the Privacy Activist Kit! This project exists to help people protect their digital privacy, and your contributions help make that mission stronger.
4+
5+
## How You Can Help
6+
7+
There are many ways to contribute, and you don't need to be a developer or security expert to make a meaningful impact:
8+
9+
### 🌟 Non-Technical Contributions
10+
11+
- **Star the repository** on GitHub to help others discover the project
12+
- **Share the project** on social media or with communities who might benefit
13+
- **Report broken links** or outdated information
14+
- **Suggest new tools or services** that align with the project's privacy-focused mission
15+
- **Improve readability** by fixing typos, clarifying language, or improving explanations
16+
- **Translate content** to make privacy resources accessible in more languages
17+
- **Share feedback** on what's working well or what could be improved
18+
19+
### 📝 Content Contributions
20+
21+
- **Add new guides** on privacy topics not yet covered
22+
- **Update existing content** with current best practices
23+
- **Create checklists** for specific use cases or threat models
24+
- **Write beginner-friendly explanations** of technical concepts
25+
- **Add real-world examples** to help illustrate privacy concepts
26+
27+
### 🔧 Technical Contributions
28+
29+
- **Fix bugs** in the website or documentation
30+
- **Improve site performance** or accessibility
31+
- **Add new features** to the VitePress site
32+
- **Optimize images** and other assets
33+
- **Improve SEO** and discoverability
34+
35+
## Getting Started
36+
37+
### Reporting Issues
38+
39+
Found a problem? [Open an issue](https://github.com/Turtlecute33/PrivacyActivistKit/issues) with:
40+
41+
- A clear, descriptive title
42+
- A detailed description of the issue
43+
- Steps to reproduce (if applicable)
44+
- Expected vs. actual behavior
45+
- Screenshots (if relevant)
46+
47+
### Making Changes
48+
49+
1. **Fork the repository** to your own GitHub account
50+
2. **Clone your fork** locally:
51+
```bash
52+
git clone https://github.com/YOUR-USERNAME/PrivacyActivistKit.git
53+
cd PrivacyActivistKit
54+
```
55+
3. **Install dependencies**:
56+
```bash
57+
npm install
58+
```
59+
4. **Create a branch** for your changes:
60+
```bash
61+
git checkout -b your-branch-name
62+
```
63+
5. **Make your changes** and test them locally:
64+
```bash
65+
npm run docs:dev
66+
```
67+
6. **Commit your changes** with a clear, descriptive message:
68+
```bash
69+
git commit -m "Add brief description of your changes"
70+
```
71+
7. **Push to your fork**:
72+
```bash
73+
git push origin your-branch-name
74+
```
75+
8. **Open a Pull Request** from your fork to the main repository
76+
77+
## Content Guidelines
78+
79+
When contributing content to the Privacy Activist Kit, please follow these principles:
80+
81+
### Voice and Tone
82+
83+
- **Clear and accessible**: Write for a general audience, not just technical experts
84+
- **Direct and practical**: Focus on actionable advice people can implement
85+
- **Empowering, not preachy**: Help people make informed choices without judgment
86+
- **Honest about trade-offs**: Privacy often involves balancing security, convenience, and usability
87+
88+
### Technical Standards
89+
90+
- **Accuracy first**: Verify information from reliable sources before adding it
91+
- **Keep it current**: Privacy tools and best practices change frequently—date-sensitive content when appropriate
92+
- **Cite sources**: Link to official documentation, research papers, or trusted organizations
93+
- **Test recommendations**: Only recommend tools you've researched or used yourself
94+
95+
### Practical Considerations
96+
97+
- **Consider diverse threat models**: What works for one person may not work for another
98+
- **Respect different risk levels**: Not everyone faces the same threats
99+
- **Avoid assumptions**: Don't assume technical knowledge, financial resources, or specific devices
100+
101+
### What NOT to Include
102+
103+
- **Affiliate links or sponsored content**: This project is independent and ad-free
104+
- **Untested or experimental tools**: Stick to well-established, trusted solutions
105+
- **Illegal activities**: Focus on defensive security, not offensive techniques
106+
- **Fear-mongering**: Be honest about risks without creating unnecessary panic
107+
- **Personal opinions as facts**: Clearly distinguish recommendations from personal preferences
108+
109+
## Code of Conduct
110+
111+
This project is committed to providing a welcoming environment for all contributors. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
112+
113+
## License
114+
115+
By contributing to this project, you agree that your contributions will be licensed under the [Creative Commons Attribution-NonCommercial 4.0 International License](LICENSE).
116+
117+
This means:
118+
- Your contributions can be freely shared and adapted
119+
- You will be credited for your work
120+
- The project will remain non-commercial
121+
122+
## Questions?
123+
124+
If you have questions about contributing, feel free to:
125+
- [Open an issue](https://github.com/Turtlecute33/PrivacyActivistKit/issues) for discussion
126+
- Reach out through the project's communication channels
127+
128+
Thank you for helping make digital privacy accessible to everyone! ✨

LICENSE

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Creative Commons Attribution-NonCommercial 4.0 International
2+
3+
This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
4+
5+
## You are free to:
6+
7+
- **Share** — copy and redistribute the material in any medium or format
8+
- **Adapt** — remix, transform, and build upon the material
9+
10+
The licensor cannot revoke these freedoms as long as you follow the license terms.
11+
12+
## Under the following terms:
13+
14+
- **Attribution** — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
15+
16+
- **NonCommercial** — You may not use the material for commercial purposes.
17+
18+
- **No additional restrictions** — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
19+
20+
## Notices:
21+
22+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
23+
24+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
25+
26+
---
27+
28+
**Full Legal Text:** https://creativecommons.org/licenses/by-nc/4.0/legalcode
29+
30+
**Human-Readable Summary:** https://creativecommons.org/licenses/by-nc/4.0/
31+
32+
**SPDX Identifier:** CC-BY-NC-4.0
33+
34+
---
35+
36+
Copyright © 2024-2025 Privacy Activist Kit Contributors

docs/.vitepress/config.mts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ import checkbox from 'markdown-it-checkbox'
55
export default defineConfig({
66
head: [
77
['link', { rel: 'icon', href: '/favicon.ico' }],
8-
['link', { rel: 'preload', href: '/assets/inter-italic-latin-ext.CN1xVJS-.woff2', as: 'font', type: 'font/woff2', crossorigin: '' }],
9-
['link', { rel: 'preload', href: '/assets/inter-roman-latin-ext.4ZJIpNVo.woff2', as: 'font', type: 'font/woff2', crossorigin: '' }],
8+
['link', { rel: 'preload', href: '/assets/inter-italic-latin-ext.CN1xVJS-.woff2', as: 'font', type: 'font/woff2', crossorigin: 'anonymous' }],
9+
['link', { rel: 'preload', href: '/assets/inter-roman-latin-ext.4ZJIpNVo.woff2', as: 'font', type: 'font/woff2', crossorigin: 'anonymous' }],
10+
// SEO
11+
['link', { rel: 'canonical', href: 'https://privacyactivistkit.org' }],
1012
// Open Graph
1113
['meta', { property: 'og:title', content: 'Privacy Activist Kit' }],
1214
['meta', { property: 'og:description', content: 'A complete guide to digital self-defense for activists, journalists, and everyone else.' }],
13-
['meta', { property: 'og:image', content: '/pak.jpg' }],
15+
['meta', { property: 'og:image', content: 'https://privacyactivistkit.org/pak.jpg' }],
1416
['meta', { property: 'og:url', content: 'https://privacyactivistkit.org' }],
17+
['meta', { property: 'og:type', content: 'website' }],
1518
// Twitter Card
1619
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
1720
['meta', { name: 'twitter:title', content: 'Privacy Activist Kit' }],
1821
['meta', { name: 'twitter:description', content: 'A complete guide to digital self-defense for activists, journalists, and everyone else.' }],
19-
['meta', { name: 'twitter:image', content: '/pak.jpg' }]
22+
['meta', { name: 'twitter:image', content: 'https://privacyactivistkit.org/pak.jpg' }]
2023
],
2124
title: "Privacy Activist Kit",
2225
description: "A complete guide to digital self-defense for activists, journalists, and everyone else.",

0 commit comments

Comments
 (0)