本页面包含有关 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 中失败并启动：问题
- jx 启动的文档 envar：问题
- 设置保险柜所需的文档：问题
- 未能将启动从本地升级到保险柜：问题
- 文档反馈“create”与“install jx”、“boot”与“import”的关系：问题
- Helm 文档随处可见：问题
- 改进了 ChartMuseum、Monocular 和 Docker Registry 为何未替换为 Nexus 问题的文档
- 使用启动 + GKE 时无法更改 Docker Registry：问题
- 无法将域名从 nip.io 更改为自定义网域：问题
对于 Jenkins X 功能矩阵，这项工作涉及（如下所述）每个云提供商（即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 的文档
项目交付成果：
- 在重构现有 Jenkins X 文档的过程中，通过 PR 修复了上述文档问题。
- 更新了 Jenkins X 功能矩阵以及关于将 Jenkins X 与其他云服务商（主要是 AKS、EKS 和 GKE）搭配使用的 Kubernetes 服务的用户文档。
- 与 Daniel 合作，基于 OpenShift 自动设置 Jenkins X 预览环境基础架构。
暂定时间表（以及任务）提出：
社区凝聚力（8 月 17 日 - 9 月 13 日）
- 为技术文档设置开发环境，以及访问 Cloud 基础架构来处理项目任务。
- 与项目导师讨论拟定的暂定时间表、项目可交付成果、任务（以及优先事项）。
- 了解并熟悉组织的工作流程和公关审核流程，并积极参与社区活动。
- 查看 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 云的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
- 解决其中一个文档问题，以改进现有 Jenkins X 文档。
第 3 周（9 月 28 日 - 10 月 4 日）
- 了解 GKE 云的 Jenkins X 功能矩阵：安装 Jenkins X 并准备用户备注草稿。
- 解决其中一个文档问题，以改进现有 Jenkins X 文档。
- 基于 OpenShift，处理 Jenkins X 的设计文档预览环境基础架构。
第 4 周（10 月 5 日 - 10 月 11 日）
- 完成 GKE 上的 Jenkins X 用户文档。
- 解决其中一个文档问题，以改进现有 Jenkins X 文档。
第 5 周（10 月 12 日 - 10 月 18 日）
- 了解 Azure 云 (AKS) 的 Jenkins X 功能矩阵：安装 Jenkins X，并准备用户备注草稿。
- 解决其中一个文档问题，以改进现有 Jenkins X 文档。
- 在获得社区成员的反馈后，基于 OpenShift 完成 Jenkins X 预览版环境基础架构的设计文档。
第 6 周（10 月 19 日 - 10 月 25 日）
- 了解 Azure 云 (AKS) 的 Jenkins X 功能矩阵：安装 Jenkins X，并准备用户备注草稿。
- 解决其中一个文档问题，以改进现有 Jenkins X 文档。
第 7 周（10 月 26 日 - 11 月 1 日）
- 了解 Azure 云 (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 有哪些优势？Google 文档 2020 季计划结束后，我打算作为社区的积极成员，长期为 Jenkins X 项目做出贡献。我将随时乐意帮助其他人（新人），并鼓励他们积极参与 Jenkins X 社区。我很乐意继续参与其他 Jenkins X 项目创意。
我之所以最适合参与这个项目，原因在于：
- 我做事很有条理，而且有条不紊。我非常期待通过每周一次的博文、安排的 SIG-docs 每周会议以及定期通过电子邮件向项目导师和组织社区了解该项目的进度。
- 我将经常寻求指导以及来自导师和社区成员的反馈，以便继续执行相关任务，确保所有人都达成共识（包容性地提及任何挑战和/或遇到的阻碍因素）。
- 定期提交所有的源代码，以便得到导师和贡献者的审核，并记录完成的工作，以供社区成员参考。
- 我具备实施这个项目创意所需的全部技术技能，并与导师 Deane、Kara 和 Daniel 讨论了项目提案。我对项目提案及可交付成果有深入了解。
- 我拥有使用 Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift、Hugo 等技术技能的经验，能够提供完整的文档，并解决当前的大部分文档相关问题。我积极进取，能够在几乎没有监督的情况下按时完成项目工作。