Jenkins X 项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：

Jenkins X

技术文档工程师：

Nitin

项目名称：

重构现有的 Jenkins X 文档网站和 Jenkins X 功能矩阵

项目时长：

标准时长（3 个月）

Project description

此项目的主要目标是重构现有的 Jenkins X 文档，同时修复文档相关问题，并准备更新后的 Jenkins X 功能矩阵以及有关在企业云服务提供商上使用 Jenkins X 的用户文档。此外，此项目还涉及与 Daniel 合作，开发基于 OpenShift 的 Jenkins X 预览环境基础架构。

在重构现有 Jenkins X 文档的过程中，我可能需要处理的一些问题包括：

• 在 EKS 资源中启动：问题
• 在 EKS 中，Vault 在启动时失败：问题
• 记录 jx 启动的环境变量：问题
• 设置保险柜所需的文档：问题
• 从本地升级到保险柜的启动升级失败：问题
• “create”与“install jx”与“boot”与“import”的文档反馈关系：问题
• Helm 文档散落各处：问题
• 改进了文档，说明了为什么 ChartMuseum、Monocular 和 Docker Registry 未替换为 Nexus 问题
• 使用 Boot + GKE 时无法更改 Docker 注册表：问题
• 将网域从 nip.io 更改为自定义网域失败：问题

对于 Jenkins X 功能矩阵，工作涉及（如下所述）各个云服务提供商提供的企业 Kubernetes 服务，即Google Cloud (GKE)、Amazon Web Services (AWS EKS) 和 Azure Cloud (AKS)。

• 通过 Terraform 脚本和 jx boot 在云端安装 Jenkins X
• 检查 Kubernetes 版本与这些云服务提供商 Kubernetes 服务上的 Jenkins X 的兼容性。
• 要与 Deane 和 Jenkins X 社区成员讨论的任何其他功能（用于 Secret 的保险柜存储、源代码控制版本或其他功能）。

关于基于 OpenShift 设置 Jenkins X 预览环境基础架构的工作，具体包括：

• 关于 OpenShift 平台上 Jenkins X 预览环境基础架构的设计文档
• 在 OpenShift 中自动创建 Jenkins X 预览环境
• 更新了有关预览环境的 Jenkins X 文档

项目交付成果：

• 通过 PR 修复了上述文档问题，并考虑了重构现有 Jenkins X 文档。
• 更新了 Jenkins X 功能矩阵，以及有关将 Jenkins X 与不同云服务提供商（主要包括 AKS、EKS 和 GKE 等 Kubernetes 服务）搭配使用方面的用户文档。
• 与 Daniel 合作，基于 OpenShift 自动设置 Jenkins X 预览环境基础架构。

建议的暂定时间表（以及任务）：

社区凝聚（8 月 17 日至 9 月 13 日）

• 为技术文档设置开发环境，并获得使用云基础架构来处理项目任务的权限。
• 与项目导师讨论提议的暂定时间表、项目交付成果以及任务（及其优先级）。
• 了解并熟悉组织的工作流程、公关审核流程，并参与社区活动。
• 查看 Jenkins X 当前的文档状态。

第 1 周（9 月 14 日至 9 月 20 日）

• 了解在云端设置 Jenkins X 的说明、当前状态和文档。
• 与 Deane 讨论了当前的 Jenkins X 功能（将在不同的云服务提供商上进行验证）。
• 与 Daniel 讨论基于 OpenShift 的 Jenkins X 预览版环境基础架构的当前状态。
• 与 Daniel 合作，为 OpenShift 上的 Jenkins X 预览环境基础架构设计架构。

第 2 周（9 月 21 日 - 9 月 27 日）

• 处理 GKE Cloud 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理某个有关改进现有 Jenkins X 文档的文档问题。

第 3 周（9 月 28 日 - 10 月 4 日）

• 处理 GKE Cloud 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理文档问题，以改进现有的 Jenkins X 文档。
• 负责基于 OpenShift 的 Jenkins X 预览环境基础架构的设计文档。

第 4 周（10 月 5 日 - 10 月 11 日）

• 完成 Jenkins X on GKE 的用户文档。
• 处理文档问题，以改进现有的 Jenkins X 文档。

第 5 周（10 月 12 日 - 10 月 18 日）

• 处理适用于 Azure Cloud (AKS) 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理某个有关改进现有 Jenkins X 文档的文档问题。
• 在收到社区成员的反馈后，为基于 OpenShift 的 Jenkins X 预览环境基础架构最终确定设计文档。

第 6 周（10 月 19 日 - 10 月 25 日）

• 处理适用于 Azure Cloud (AKS) 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理文档问题，以改进现有的 Jenkins X 文档。

第 7 周（10 月 26 日至 11 月 1 日）

• 处理适用于 Azure Cloud (AKS) 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理文档问题，以改进现有的 Jenkins X 文档。
• 着手基于 OpenShift 设置 Jenkins X 预览环境基础架构。

第 8 周（11 月 2 日至 11 月 8 日）

• 在 AKS 上最终确定 Jenkins X 的用户文档。
• 处理文档问题，以改进现有的 Jenkins X 文档。

第 9 周（11 月 9 日至 11 月 15 日）

• 处理适用于 AWS (EKS) 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理文档问题，以改进现有的 Jenkins X 文档。
• 着手基于 OpenShift 设置 Jenkins X 预览环境基础架构。

第 10 周（11 月 16 日 - 11 月 22 日）

• 处理适用于 AWS (EKS) 的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
• 处理文档问题，以改进现有的 Jenkins X 文档。

第 11 周（11 月 23 日 - 11 月 29 日）

• 完成 EKS 上 Jenkins X 的用户文档。
• 处理文档问题，以改进现有的 Jenkins X 文档。
• 在 Jenkins X 文档网站上完成 Jenkins X 预览环境基础架构的文档。

第 12 周（11 月 30 日至 12 月 5 日）

• 根据反馈最终确定项目交付成果，并重构代码（如果有）。
• 测试 Jenkins X 文档网站的运作情况，包括链接、图片、超链接等。
• 检查 Jenkins X 文档网站的用户定义控件和导航。
• 查看 Jenkins X 功能矩阵的最终演示文稿。

2020 年 12 月 10 日之前 技术编写人员和导师都提交项目评估。

提议的项目对 Jenkins X 及其社区有哪些好处？ 此项目将帮助 Jenkins X 社区改进文档，以便最终用户和开发者参考 Jenkins X 的技术架构、兼容性、使用和集成。完成此提议的项目后，我们将拥有一套全面、明确且经过技术验证的 Jenkins X 用户文档，以及 Jenkins X 功能矩阵，以便了解 Jenkins X 与不同云服务提供商的兼容性。

您计划通过 Jenkins X 获得哪些未来好处？ 2020 年 Google 文档季活动结束后，我计划成为 Jenkins X 项目的长期贡献者，并成为社区的活跃成员。我将随时为他人（新手）提供帮助，并鼓励他们参与 Jenkins X 社区。我非常乐意尝试其他 Jenkins X 项目想法。

以下是我最适合参与此项目的一些原因：

• 我做事有条不紊。我非常希望通过每周一次的博文、定期召开的 SIG-docs 每周会议以及定期发送的电子邮件，向项目导师和组织社区及时通报项目进展。
• 将经常向导师和社区成员寻求指导和反馈，以便推进任务，并确保每个人都步调一致（包括提及任何挑战和/或面临的阻碍点）。
• 定期提交编写的所有源代码，以便获得导师和贡献者的代码审核，并记录所做的工作以供社区成员参考。
• 我具备实现此项目想法所需的所有技术技能，并已与导师 Deane、Kara 和 Daniel 讨论过项目提案。我深入了解了项目提案及其交付成果。
• 我拥有提供完善文档以及解决当前大多数与文档相关的问题所需的技术技能（Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift、Hugo 等）。我具有积极乐观的态度，能够在几乎不需要监督的情况下按时完成项目工作。