Skip to content

Commit 2dcd4a4

Browse files
authored
article mirrored
1 parent a47bc8b commit 2dcd4a4

File tree

1 file changed

+53
-48
lines changed

1 file changed

+53
-48
lines changed

content/en/blog/_posts/2024-04-28-contribute-as-sig-docs-reviewer.md

Lines changed: 53 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,70 @@
11
---
22
layout: blog
33
title: "From Code to Quill: Embark on a Legendary Kubernetes Quest with SIG Docs"
4-
date: 2024-04-28
4+
date: 2024-05-16
55
slug: contribute-as-sig-docs-reviewer
6-
author: >
7-
Ricardo Amaro (Acquia)
6+
author: "Ricardo Amaro (Acquia)"
87
---
98

10-
You've probably come across the saying, "Contributing doesn't always mean writing lines of code"
11-
whispered to the wind or glimpsed in the margins of a sacred open-source tome.
12-
What is the truth behind this tale as old as time (or at least as old as Kubernetes itself)?
9+
You've likely heard the adage, "Contributing isn't just about writing code",
10+
whispered in forums or seen etched into the digital walls of open source communities.
11+
But what depth of truth lies within this ancient wisdom, especially in the vast,
12+
evolving world of Kubernetes?
1313

14-
Imagine Sarah: an enthusiast of open-source whose keyboard had seen more action crafting
15-
technical masterpieces for her projects than a knight's sword in battle. Sarah's had such
16-
a smooth relationship with Git, that she could `git commit` and `git push` in her sleep,
17-
and her etiquette in pull requests was so polished, it could make a silver spoon look tarnished.
14+
Today, contributing to open source extends far beyond the realm of coding.
15+
It's an inclusive journey that welcomes the diverse skills of all who wish
16+
to be a part of it. Whether you're a seasoned developer or someone whose strengths
17+
lie outside traditional programming, your contributions hold immense value.
1818

19-
But here's the twist: when it came to the mysterious _art-of-coding_, Sarah felt more
20-
like a fish out of water — or more accurately, like trying to navigate a Kubernetes cluster
21-
with a compass and a star map. The very thought of diving into the codebase made her feel like
22-
she was trying to read ancient hieroglyphs without a Rosetta Stone.
19+
Imagine yourself embarking on a journey that leverages your expertise and love
20+
for free software to enhance your capabilities and strengthen the very foundation
21+
of the Kubernetes ecosystem. This is a real opportunity for you to shine, to make
22+
an indelible mark on a project that powers some of the most critical infrastructure
23+
in the world today.
2324

24-
Did Sarah let this stop her? Not at all. She discovered a path as impactful as a well-placed
25-
line of code: joining the Special Interest Group (SIG) Docs team. It was there that Sarah found her true calling,
26-
helping transform the dense field of Kubernetes documentation into a well-tended garden of knowledge.
25+
Your journey begins with a single step: joining the Special Interest Group (SIG) Docs.
26+
Here, your talent for articulating complex concepts, your keen eye for detail,
27+
and your unwavering commitment to clarity become your most powerful tools. As a contributor,
28+
you can transform dense technical landscapes into navigable pathways, making Kubernetes
29+
accessible to all.
2730

28-
Sarah's odyssey from a mere mortal Kubernetes user to a demigod of documentation didn't
29-
just prove that contributions of knowledge and expertise are as valuable as code
30-
contributions—it also showed that you don't need to be a coding wizard to make a significant
31-
impact. Her journey is a beacon of hope for all who fear the merge conflict, a testament
32-
to the power of the written word in the realm of open-source.
31+
This is your call to adventure, an invitation to expand beyond the familiar territories
32+
of code and into the rich, uncharted domains of documentation and collaboration,
33+
empowering a global community of users and contributors.
3334

34-
So, let Sarah's story inspire you. No matter if you're a code ninja or a prose maestro,
35-
there's a place for you in the open-source pantheon. And who knows? Maybe one day,
36-
your documentation will be the guiding light for a lost soul in the Kubernetes sea,
37-
making you the unsung hero of their open-source odyssey.
35+
## Why become a SIG Docs reviewer?
3836

39-
## Why Become a SIG Docs Reviewer?
40-
41-
The Kubernetes project depends substantially on SIG Docs to ensure that documentation
37+
The Kubernetes project depends substantially on the SIG Docs to ensure that documentation
4238
is accurate, up to date, and easily accessible. By becoming a reviewer, you can help users
4339
and contributors navigate and understand Kubernetes more effectively. In addition, reviewing
44-
documentation provides unique opportunities to:
40+
documentation provides unique opportunities for:
4541

46-
- **Expand your Kubernetes knowledge**: Engage deeply with new features and functionalities
42+
- **Expanding your Kubernetes knowledge**: Engage deeply with new features and functionalities
4743
by reviewing their documentation.
48-
- **Improve your technical writing skills**: Develop an eye for detail and clarity in technical
44+
- **Improving your technical writing skills**: Develop an eye for detail and clarity in technical
4945
writing.
50-
- **Strengthen the Kubernetes community**: Help maintain the high quality of Kubernetes
46+
- **Strengthening the Kubernetes community**: Help maintain the high quality of Kubernetes
5147
documentation, supporting both new and experienced users.
52-
- **Build your network**: Expanding your professional network, and getting together with
48+
- **Building your network**: Expanding your professional network, and getting together with
5349
contributors from around the globe.
5450

55-
## Who Are We Looking For?
51+
## Who are we looking for?
5652

57-
We're seeking open-source enthusiasts with:
53+
We're seeking open source enthusiasts with:
5854

59-
- Experience with Git and GitHub, comfortable with the process of reviewing pull requests
55+
- Experience of Git and GitHub, comfortable with the process of reviewing pull requests
6056
and providing constructive feedback.
6157
- Familiarity with Markdown and documentation frameworks (Hugo experience is a plus but
6258
not required).
6359
- A passion for making complex technical concepts understandable and accessible.
6460

65-
Prior experience in technical writing or documentation review in any open-source project
66-
will be beneficial but not mandatory.
61+
Experience in technical writing or documentation review in open source projects is beneficial,
62+
but not mandatory. Kubernetes experience is welcome at all levels. Those less familiar
63+
with Kubernetes or containers can provide valuable fresh perspectives for beginners accessibility.
64+
We value diversity of experiences and the fresh eyes you can provide to make sure our content
65+
is clear and understandable for everyone.
6766

68-
## How to Get Started
67+
## How to get started
6968

7069
Becoming a SIG Docs reviewer is a journey that starts with familiarizing yourself with the
7170
Kubernetes documentation contribution process. Here are the steps to get you started:
@@ -82,26 +81,32 @@ Kubernetes documentation contribution process. Here are the steps to get you sta
8281
`good first issue` or `help wanted`. These are great for beginners. Leave constructive
8382
feedback and suggestions. Familiarize yourself with the
8483
[content guide](/docs/contribute/style/content-guide/) and the
85-
[style guide](/docs/contribute/style/style-guide/) to provide more effective
84+
[style guide](/docs/contribute/style/style-guide/) to provide more effectively
8685
[reviewing Pull Requests](/docs/contribute/review/reviewing-prs/).
8786

8887
1. **Attend SIG Docs Meetings**: Participate in the
8988
[SIG Docs meetings](https://github.com/kubernetes/community/tree/master/sig-docs). These
9089
meetings are an excellent opportunity to meet fellow contributors, discuss documentation
9190
improvements, and volunteer for reviewing tasks.
9291

93-
1. **Shadow an Experienced Reviewer**: If possible, shadow an
94-
[experienced reviewer](/docs/contribute/participate/roles-and-responsibilities/)
95-
to learn best practices and tips for reviewing efficiently and effectively.
92+
1. **Shadow an Experienced Reviewer**: To better understand the review process, sign up for our official
93+
[PR Wrangling shadow program](/docs/contribute/participate/pr-wranglers/#pr-wrangler-shadow-program)
94+
where you will be able to shadow an [experienced reviewer](/docs/contribute/participate/roles-and-responsibilities/)
95+
and learn best practices and tips for reviewing efficiently and effectively.
96+
97+
1. **Contributor Ladder**: Familiarize yourself with the
98+
[CNCF contributor ladder](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md),
99+
which guides your progression from newcomer to advanced contributor roles in the Kubernetes community.
96100

97-
## What's Next?
101+
## What's next?
98102

99103
After consistently contributing to documentation reviews and demonstrating your understanding
100104
of Kubernetes documentation standards, you can express your interest in becoming an official
101-
SIG Docs reviewer. As you build up this skill set, reviews are still welcome! You don't need to be a formal reviewer in the SIG to leave reviews on PRs or blog posts. Engage with the SIG Docs chairs or leads on Slack or during SIG Docs
102-
meetings to discuss the next steps.
105+
SIG Docs reviewer. Engage with the SIG Docs chairs or leads on the
106+
[public Slack channel](https://kubernetes.slack.com/channels/C1J0BPD2M)
107+
or during SIG Docs meetings to discuss the next steps.
103108

104-
## See YOU in the Docs!
109+
## See _you_ in the docs!
105110

106111
Becoming a SIG Docs reviewer is more than contributing; it's embracing the heart of the
107112
Kubernetes community 🚀. Enhance your knowledge and writing skills while contributing

0 commit comments

Comments
 (0)