Welcome to the contributor workspace. Start a draft, develop it in the correct area, check your work, and submit it for editorial review.
๐ Quick Start
| Step | Action | Destination |
|---|---|---|
| 1 | Read the required standards | Contributor Guidelines |
| 2 | Choose a reusable page structure | Template Library |
| 3 | Start unfinished or uncertain work | Drafts |
| 4 | Develop the contribution in its proper area | Labs, Guides, or Write-ups |
| 5 | Complete the self-check and submit | Submitted Contributions |
๐ฏ Program Purpose
The program welcomes students, professionals, and hobbyists who want to build a trusted collection of practical, accurate technical knowledge. Quality and consistency are essential, and contributors receive public credit for approved work.
๐ Core Rules
Edits that do not follow these rules may be reverted, and contributor access may be revoked.
- Markdown only: use headings, tables, lists, inline code, and labeled code blocks.
- Original work or attribution: cite outside material; plagiarism is not permitted.
- Accuracy over speed: test commands and state versions, assumptions, and limitations.
- Professional tone: no attacks, gatekeeping, or unmarked opinion.
- Safe and lawful content: no harmful malware, credentials, private data, or exploit kits.
- Respect the structure: keep pages focused and do not reorganize core directories without approval.
The complete standard, examples, and recommendations live in the Contributor Guidelines.
๐๏ธ Editable Areas
Contributor access is limited to pages beneath:
/contributors/
| Area | Use It For |
|---|---|
| ๐ Drafts | Early ideas, research, incomplete work, and anything not yet categorized |
| ๐งช Labs | Reproducible, hands-on exercises |
| ๐ Guides | Polished how-to and reference material |
| ๐ Write-ups | Analysis, investigations, and problem-solving narratives |
| ๐ฌ Submitted | Completed work awaiting editorial review |
Everything outside this directory is read-only unless access is explicitly granted.
๐ Contribution Workflow
1. โ๏ธ Create and Edit
- Create the page under
/contributors/. - Use a lowercase, hyphen-separated path.
- Add this information at the top:
> **Author:** Your name or handle
> **Difficulty:** Beginner | Intermediate | Advanced
> **Status:** Draft
{.is-info}
2. โ Self-Review
Before submitting, confirm:
- Markdown renders correctly
- Code blocks have language labels
- Commands are safe to copy and paste
- Operating systems, versions, and prerequisites are stated
- Spelling and grammar are clean
- Links work
- Sensitive data is removed
- Diagrams and a Common Pitfalls section are included where useful
3. ๐ค Submit
- Change the page status to Submitted.
- Add the page to the submission index.
- Do not move or rename it after submission.
An editor will review technical accuracy, structure, clarity, and compliance. Revisions may be requested.
๐ After Review
An editor may:
- Approve and promote the page to the main wiki
- Request revisions
- Reject the submission with feedback
Approved contributors are credited as authors. Strong contributors may also receive early feature access, invitations to paid contribution programs, and future revenue-sharing opportunities.
๐ Need Help?
Review a similar existing page, consult the Contributor Guidelines, or ask in the relevant pageโs discussion area.