Jenkins 拥有大量的文档,我们欢迎任何对文档的贡献:新文档、设计和风格、文案编辑、评审等。
Jenkins 中有许多文档来源。本网站和 插件网站 是最值得注意的,但我们在其他地方也有文档(GitHub 存储库、各种网站,如 javadoc.jenkins.io 或 已弃用的 Jenkins Wiki)。对于大多数存储库,我们都尝试遵循“文档即代码”的方法。
| 文档类型 | Repository | 注释和链接 |
|---|---|---|
贡献指南. |
||
贡献指南. |
||
插件存储库或 Jenkins Wiki |
有关插件文档以及从 Wiki 迁移到 GitHub 的信息,请参阅 开发者文档。 |
如果您是新贡献者,文档是一个很棒的贡献领域。即使不进行存储库分叉和本地克隆,也可以通过 GitHub 的 Web 界面完成许多小型修补。您可以打开任何 Jenkins 存储库中的任何 GitHub Markdown 或 Asciidoc 页面,点击页面上的编辑,在 Web 界面中修改和预览更改,然后提交一个更改。
有用的链接
更高级的文档任务(未设置“good first issue”标签)
文档 SIG 页面,包含 Jenkins 文档的链接
GitHub 上的写作和格式(适用于 Github Markdown 文档)
文档问题列表包含适合首次贡献者的问题。请参阅 “新手友好问题”列表。
如果您决定处理某个问题,请在问题下方添加评论,告知他人您正在处理该问题。例如,添加评论“我正在处理此问题”。您无需等待他人分配给您一个问题。选择一个问题,添加评论,然后开始写作。
目前我们正在将文档从 Jenkins Wiki 迁移到 GitHub 和 jenkins.io。有关迁移原因的更多信息,请参阅 这篇博文。此迁移涉及数百个页面和存储库的修改,我们邀请所有人参与贡献。
Jenkins 用户文档最初是在 Jenkins Wiki 中创建的。Jenkins Wiki 于 2019 年设置为只读。Jenkins 文档的改进现在在 www.jenkins.io 上的 Jenkins 文档站点进行。
已弃用的 Jenkins Wiki 上的一些文档仍然有用。有经验的 Jenkins 用户和管理员可能会找到仍然准确并可以添加到 www.jenkins.io 的 Wiki 信息。鼓励他们在这些情况下提交拉取请求。
这**不是**一项适合新贡献者或 Jenkins 经验不足的用户执行的任务。新贡献者和 Jenkins 经验不足的用户应协助处理其他文档任务,而不是尝试将文档从 wiki 迁移到 www.jenkins.io。