Skip to content

Commit 373ef34

Browse files
authored
Merge pull request #46054 from ricardoamaro/reviewingk8s
Contribute as sig-docs reviewer blog post
2 parents ead0d23 + 52ebe04 commit 373ef34

File tree

1 file changed

+115
-0
lines changed

1 file changed

+115
-0
lines changed
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
layout: blog
3+
title: "From Code to Quill: Embark on a Legendary Kubernetes Quest with SIG Docs"
4+
date: 2024-05-16
5+
slug: contribute-as-sig-docs-reviewer
6+
canonicalUrl: https://www.kubernetes.dev/blog/2024/05/16/contribute-as-sig-docs-reviewer/
7+
author: "Ricardo Amaro (Acquia)"
8+
---
9+
10+
You've likely heard the adage, "Contributing isn't just about writing code",
11+
whispered in forums or seen etched into the digital walls of open source communities.
12+
But what depth of truth lies within this ancient wisdom, especially in the vast,
13+
evolving world of Kubernetes?
14+
15+
Today, contributing to open source extends far beyond the realm of coding.
16+
It's an inclusive journey that welcomes the diverse skills of all who wish
17+
to be a part of it. Whether you're a seasoned developer or someone whose strengths
18+
lie outside traditional programming, your contributions hold immense value.
19+
20+
Imagine yourself embarking on a journey that leverages your expertise and love
21+
for free software to enhance your capabilities and strengthen the very foundation
22+
of the Kubernetes ecosystem. This is a real opportunity for you to shine, to make
23+
an indelible mark on a project that powers some of the most critical infrastructure
24+
in the world today.
25+
26+
Your journey begins with a single step: joining the Special Interest Group (SIG) Docs.
27+
Here, your talent for articulating complex concepts, your keen eye for detail,
28+
and your unwavering commitment to clarity become your most powerful tools. As a contributor,
29+
you can transform dense technical landscapes into navigable pathways, making Kubernetes
30+
accessible to all.
31+
32+
This is your call to adventure, an invitation to expand beyond the familiar territories
33+
of code and into the rich, uncharted domains of documentation and collaboration,
34+
empowering a global community of users and contributors.
35+
36+
## Why become a SIG Docs reviewer?
37+
38+
The Kubernetes project depends substantially on the SIG Docs to ensure that documentation
39+
is accurate, up to date, and easily accessible. By becoming a reviewer, you can help users
40+
and contributors navigate and understand Kubernetes more effectively. In addition, reviewing
41+
documentation provides unique opportunities for:
42+
43+
- **Expanding your Kubernetes knowledge**: Engage deeply with new features and functionalities
44+
by reviewing their documentation.
45+
- **Improving your technical writing skills**: Develop an eye for detail and clarity in technical
46+
writing.
47+
- **Strengthening the Kubernetes community**: Help maintain the high quality of Kubernetes
48+
documentation, supporting both new and experienced users.
49+
- **Building your network**: Expanding your professional network, and getting together with
50+
contributors from around the globe.
51+
52+
## Who are we looking for?
53+
54+
We're seeking open source enthusiasts with:
55+
56+
- Experience of Git and GitHub, comfortable with the process of reviewing pull requests
57+
and providing constructive feedback.
58+
- Familiarity with Markdown and documentation frameworks (Hugo experience is a plus but
59+
not required).
60+
- A passion for making complex technical concepts understandable and accessible.
61+
62+
Experience in technical writing or documentation review in open source projects is beneficial,
63+
but not mandatory. Kubernetes experience is welcome at all levels. Those less familiar
64+
with Kubernetes or containers can provide valuable fresh perspectives for beginners accessibility.
65+
We value diversity of experiences and the fresh eyes you can provide to make sure our content
66+
is clear and understandable for everyone.
67+
68+
## How to get started
69+
70+
Becoming a SIG Docs reviewer is a journey that starts with familiarizing yourself with the
71+
Kubernetes documentation contribution process. Here are the steps to get you started:
72+
73+
1. **Familiarize Yourself with SIG Docs**: Start by reading the
74+
[SIG Docs contributor guide](/docs/contribute/) to understand
75+
how documentation contributions are made.
76+
77+
1. **Join the Kubernetes Slack**: Connect with the SIG Docs community on the
78+
[#sig-docs channel](https://kubernetes.slack.com/messages/sig-docs). It's a great place
79+
to ask questions, find mentorship, and get to know the community.
80+
81+
1. **Start Reviewing Pull Requests**: Look for open pull requests labeled with
82+
`good first issue` or `help wanted`. These are great for beginners. Leave constructive
83+
feedback and suggestions. Familiarize yourself with the
84+
[content guide](/docs/contribute/style/content-guide/) and the
85+
[style guide](/docs/contribute/style/style-guide/) to provide more effectively
86+
[reviewing Pull Requests](/docs/contribute/review/reviewing-prs/).
87+
88+
1. **Attend SIG Docs Meetings**: Participate in the
89+
[SIG Docs meetings](https://github.com/kubernetes/community/tree/master/sig-docs). These
90+
meetings are an excellent opportunity to meet fellow contributors, discuss documentation
91+
improvements, and volunteer for reviewing tasks.
92+
93+
1. **Shadow an Experienced Reviewer**: To better understand the review process, sign up for our official
94+
[PR Wrangling shadow program](/docs/contribute/participate/pr-wranglers/#pr-wrangler-shadow-program)
95+
where you will be able to shadow an [experienced reviewer](/docs/contribute/participate/roles-and-responsibilities/)
96+
and learn best practices and tips for reviewing efficiently and effectively.
97+
98+
1. **Contributor Ladder**: Familiarize yourself with the
99+
[CNCF contributor ladder](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md),
100+
which guides your progression from newcomer to advanced contributor roles in the Kubernetes community.
101+
102+
## What's next?
103+
104+
After consistently contributing to documentation reviews and demonstrating your understanding
105+
of Kubernetes documentation standards, you can express your interest in becoming an official
106+
SIG Docs reviewer. Engage with the SIG Docs chairs or leads on the
107+
[public Slack channel](https://kubernetes.slack.com/channels/C1J0BPD2M)
108+
or during SIG Docs meetings to discuss the next steps.
109+
110+
## See _you_ in the docs!
111+
112+
Becoming a SIG Docs reviewer is more than contributing; it's embracing the heart of the
113+
Kubernetes community 🚀. Enhance your knowledge and writing skills while contributing
114+
to our valuable documentation. This is your opportunity to guide others with your expertise
115+
and make a lasting impact. Welcome aboard—see you there! 🌟

0 commit comments

Comments
 (0)