文档并不迷人,但它是好的。

- - - - - -托马斯水獭

必威国际有限公司Jenkins技术文档是我们项目的重要组成部分,因为它是使用Jenkins的关键。好的文档可以指导用户并鼓励选择好的实现。它是用户体验的关键部分。

在最近的Jenkins UI必威国际有限公司/UX黑客大会上,文档是改进Jenkins用户体验的一个特别的途径。我们从经验丰富的Jenkins贡献者和新手那里得到了许多改进。必威国际有限公司来自世界各地的贡献者提交了关于安装、管理、管理和操作Jenkins的文档请求。必威国际有限公司

贡献者按国家

从Wiki迁移文档

Jenk必威国际有限公司ins Wiki页面为Jenkins用户收集了15年的经验和智慧。然而,这些经验和智慧与不准确、不完整和过时的信息混杂在一起。

Jenk必威国际有限公司ins Wiki迁移项目确定了Jenkins Wiki上访问次数最多的50个页面,并创建了GitHub问题来跟踪这些页面迁移到www.nepalikorea.com。这是我们第一次使用GitHub问题文档进行大规模实验。结果是非常积极的。Hackfest贡献者在许多文档章节中添加了新的章节,包括:

Hackfest解决了19个wiki迁移问题。另外25个wiki迁移问题的工作正在进行中。我们已经取得了很大的进步,并期待在未来取得更好的成绩。新贡献者非常有效地使用了“良好的第一期”标签。我们在25个“良好的第一个问题”中大部分未分配的情况下开始了Hackfest,并在14个已结束、10个正在进行的情况下完成了Hackfest。当我们使用Jenkins Wiki迁移来欢迎新的文档贡献者时,我们将提供更多“良好的首要问题”。必威国际有限公司

示例Hackfest文档页面

迁移插件文档

插件文档也处于过渡阶段。自2019年11月以来,插件一直在将其文档转移到托管插件源代码的GitHub存储库中。这“文档代码”方法允许插件维护者在实现新功能的pull请求中包括文档改进。它确保文档变更由评审和批准新功能的同一维护人员评审。

Hackfest参与者提交了pull请求,将插件文档迁移到GitHub。来自Hackfest的10个插件拉取请求正在进行中。来自Hackfest的5个插件拉取请求已经合并,正在等待插件的发布。

chucknorris使用文档作为代码

本着乐趣和冒险的精神,Oleg Nenashev将“Chuck Norris插件”迁移到GitHub文档中作为代码现场Hackfest演示2020年5月26日.可以从以下网站获得该记录、插件迁移指南和导出工具的链接“将插件迁移到文档作为代码”

chucknorris插件使用文档作为代码

文档更新

必威国际有限公司Jenkins与其他技术合作,解决许多不同环境下的自动化挑战。我们描述这些环境88必威 .作为Hackfest的一部分,我们已经开始对解决方案页面进行一系列改进。

88必威 现在包括更新的视频和更好的页面布局,更容易阅读和更好的导航。其他解决方案页面将在未来得到类似的改进。

必威国际有限公司Jenkins和码头工人

系统属性

Jenkins的全局配置可以在启动时通过定义Java属性必威国际有限公司进行修改。系统属性可以更改系统默认值,并在新的默认配置可能与现有安装不兼容时提供兼容性“出口”。

作为Hackfest的一部分,Daniel Beck改进了系统属性页面的导航和用户体验。现在阅读和引用都更容易了,只要将鼠标移到每个属性的右边,就可以获得可嵌入的链接,以及对每个属性进行分类和分类的标签。

系统属性

插件网站改进

在黑客节期间,加文·莫根继续努力改进必威国际有限公司詹金斯插件的网站这样用户可以很容易地访问插件更改日志和报告的问题。一旦这个pull请求被合并,它将极大地改善那些想要更新插件的Jenkins用户的体验,并查找关于插件中发生了什么变化以及他们可能遇到的问题的文档。必威国际有限公司

Jira插件的UI示例:

插件的网站

接下来是什么?

在Jenkins文档中还有很多事情要做,我们需要你的帮助。必威国际有限公司有很多方法参与在詹金斯项目中必威国际有限公司,包括文档.看到贡献的指导方针详细说明。加入文档聊天提供个性化的帮助和鼓励。

詹金斯项必威国际有限公司目也被接受了谷歌医生季今年。这个开源导师计划将开源和技术作家社区聚集在一起,为双方带来好处。我们正在寻找有兴趣在2020年9月至12月为该项目做出贡献的技术作家。这是一个学习“文档即代码”工具和更多了解如何为开源项目做出贡献的好机会。你可以找到Jenkins项必威国际有限公司目的想法和更多信息在这里

关于作者
特蕾西·米兰达

Tracy是CloudBees开源社区总监,长期以来一直是开源贡献者和传播者。