文档

Google Season of Docs 将开源社区和技术撰稿人聚集在一起，造福双方。该计划提高了人们对开源、文档和技术写作的认识。目前没有参加 Google Season of Docs 的计划，但如果您好奇，请参阅我们的 Google Season of Docs 页面，了解过往文档项目创意和其他信息。

截至 2025 年 5 月，Google Season of Docs 项目已结束。该结论最初在 Google Summer of Code 用户组中公布，目前显示在主 GSoD 页面上。稍后将通过 Google Open Source Blog 提供更多信息。

此前，SIG 将插件文档从 Jenkins Wiki 迁移到了 GitHub。GitHub 存储库中的插件文档为寻求文档的 Jenkins 用户提供了良好的用户体验。通过执行此次迁移，插件维护者现在可以遵循“文档即代码”的方法，将文档更改作为拉取请求的一部分。这还为审查文档更改和添加文档贡献者认可创造了机会，特别是如果该流程与 更新日志自动化相结合。

截至 2024 年 3 月，已有 1,000 多个插件使用 GitHub 作为文档来源，但仍有 数百个插件需要迁移。我们邀请贡献者参与该项目，并帮助我们迁移文档。这也是更新和审校文档的绝佳机会。

有用的链接

当前，Jenkins 插件网站使用 GitHub 获取插件文档（见上文）和标签（使用 GitHub 主题）。发布信息也从 GitHub 发布中提取。仍有一些改进领域，例如解析 CHANGELOG.md 文件以获取未使用的 GitHub 发行的插件的发布信息。该项目在 WEBSITE-637 EPIC 中进行了跟踪。

有用的链接

Jenkins 用户主题包含在当前的 Jenkins Handbook 中。意见征集经常收到关于改进用户文档的请求。常见的改进主题包括从 Wiki 迁移文档、为每个 pipeline 步骤提供 pipeline 示例、为新用户提供额外的教程、改进搜索和导航。

Jenkins 管理主题包含在当前的 Jenkins Handbook 中。由于这些主题已包含在内，我们不会将管理主题分离到单独的卷中。在审查其他项目文档时，很少有（如果有的话）有单独的管理员指南。因此，我们保持用户手册现状，管理主题是整体文档的一部分。

Jenkins 解决方案页面重点介绍了 Jenkins 用户的特定用例。这些解决方案包括 SCM 提供商解决方案（GitHub、Bitbucket）、编程语言解决方案（Python、Ruby、C/C++、Java 和 PHP）以及执行环境解决方案（Pipeline、Docker、Embedded 和 Android）。Zbynek Konecny 提供了一个出色的 入门页面。 Alyssa Tong 正在收集额外的用例和用户故事。

自最初启动该项目以来，这些解决方案页面的外观和导航已得到改进。已对现有页面进行了审查和改进，以便特定解决方案的用户可以在 jenkins.io 上找到他们需要的内容。该项目在 WEBSITE-742 EPIC 中进行了跟踪。

SIG 的会议议程和会议记录发布在 此 Google 文档中。任何人都可以通过在 议程中建议更改来为即将举行的会议添加议题。