从敲代码到抒发文笔:与 SIG Docs 一起踏上传奇的 Kubernetes 探险之旅

2024年 5月 16日 75.3k 0

By Ricardo Amaro (Acquia) |

你可能在论坛中听过或在开源社区的数字墙上见过这么一句格言:“做贡献不仅仅是写代码”。
特别是在这个广阔、不断发展的 Kubernetes 社区中,这句古老的智慧格言真正意味着什么呢?

如今,为开源做贡献远远超出了敲代码的范畴。
做贡献是一段内涵丰富的旅程,我们欢迎所有有志之士展露自己的各类技能。
不论你是经验丰富的开发者,还是在传统编程之外拥有特长的人,你的贡献都有很大价值。

想象一下,踏上一段这样的旅程,既能充分发挥你的专业知识,又能尽情抒展你对自由软件的热爱,
在这个贡献过程中既增强了你的能力,又巩固了 Kubernetes 生态体系的基础。
这是一个让你闪耀光芒的真正机遇,能够让你在支撑当今世界某些最关键基础设施的项目上留下不可磨灭的印记。

你的旅程始于简单的一步:加入特别兴趣小组 (SIG) Docs。
在这个小组,你对复杂概念的表达能力、对细节的敏锐眼光以及对清晰易懂的不懈追求将成为你最强大的工具。
作为一名贡献者,你将从密集复杂的技术内容中找出一条易于上手的路径,让大众都能使用 Kubernetes。

这是一次有关冒险的召唤,一份超越代码领域的邀请,指引你踏入文档创作与社区协作的未知境地。
在这里,你将为全球用户和贡献者组成的社区赋能,点亮他们前行的道路。

为什么要成为 SIG Docs Reviewer?

Kubernetes 项目在很大程度上依赖于 SIG Docs 小组成员们确保文档准确无误、与时俱进、好用易懂。
你成为 Reviewer 后,就可以帮助用户和贡献者们更有效地探索和学习 Kubernetes。
此外,你在评审文档时还将收获一些独特的机会:

  • 拓展你的 Kubernetes 知识:通过评审文档深入了解新的功能特性。
  • 提高你的技术写作技巧:培养技术写作中注重细节和清晰阐述的能力。
  • 巩固 Kubernetes 社区:帮助维护优质的 Kubernetes 文档,方便新老用户查阅。
  • 建立你的人脉:拓展你的专业人际网络,认识来自全球的贡献者。

我们在寻找什么样的人?

我们正在寻找对开源充满热情且具备以下能力的人士:

  • 拥有 Git 和 GitHub 的经验,熟悉评审 PR 的流程,并能提供建设性的反馈。
  • 熟悉 Markdown 和文档框架(有 Hugo 经验是加分项,但不是必需的)。
  • 热衷于让复杂的技术概念变得易懂好用。

在开源项目中有技术写作或文档评审经验是加分项,但并非必需。我们欢迎对 Kubernetes 有各种经验的贡献者。
那些对 Kubernetes 或容器不太熟悉的新人,可以为初学者提供宝贵的全新视角。
我们重视多样化的经验和新视角,以确保我们的文档内容对每个人都清晰易懂。

如何开始

成为 SIG Docs Reviewer 是一段从熟悉 Kubernetes 文档贡献流程开始的旅程。以下是入门步骤:

  • 熟悉 SIG Docs:首先阅读 SIG Docs 贡献者指南,了解如何做文档贡献。

  • 加入 Kubernetes Slack:在 #sig-docs 频道与
    SIG Docs 社区建立联系。Slack 是一个提问、寻求指教和了解社区的好地方。

  • 开始评审 PR:查找打了 good first issuehelp wanted 标签的开放 PR。
    这些 PR 对 Reviewer 新手来说是很好的选择。你可以在其中留下建设性的反馈和建议。
    你还要熟悉内容指南和样式指南,
    以便更有效地评审 PR。
  • 参加 SIG Docs 会议:参与 SIG Docs 会议。
    这些会议是结识其他贡献者、讨论文档改进和志愿评审任务的绝佳机会。
  • 成为资深 Reviewer 的影子:若想更好地理解评审过程,请报名参加我们的
    PR 管理影子计划,
    你将能够成为资深 Reviewer的影子,
    学习高效和有效评审的良好实践和技巧。
  • 贡献者阶梯:熟悉 CNCF 贡献者阶梯,
    这能帮助你从新手进阶为 Kubernetes 社区中高级贡献者角色。
  • 接下来

    在文档评审方面持续贡献并展示你对 Kubernetes 文档标准的理解后,你可以表达成为正式 SIG Docs Reviewer 的兴趣。
    你可以在公共 Slack 频道或 SIG Docs 会议期间与
    SIG Docs Chair 或 Lead 讨论后续步骤。

    希望在文档中看到你的名字!

    成为 SIG Docs Reviewer 不仅仅是做贡献;这说明你已进入 Kubernetes 社区的核心 🚀。
    你在为宝贵文档做贡献的同时也能提升自己的理论知识和写作技巧。
    这是你用自己的专业知识指导他人并产生持久影响的机会。
    欢迎你加入团队,我们在 SIG Docs 不见不散!🌟

    相关文章

    KubeSphere 部署向量数据库 Milvus 实战指南
    探索 Kubernetes 持久化存储之 Longhorn 初窥门径
    征服 Docker 镜像访问限制!KubeSphere v3.4.1 成功部署全攻略
    那些年在 Terraform 上吃到的糖和踩过的坑
    无需 Kubernetes 测试 Kubernetes 网络实现
    Kubernetes v1.31 中的移除和主要变更

    发布评论