本文首發(fā)于： Jenkins 中文社區(qū)
原文鏈接 作者：Mark Waite, Tracy Miranda
譯者：wenjunzhangp
Jenkins Hackfest 用戶(hù)體驗(yàn)文檔報(bào)告
通過(guò) Hackfest，我們得到了很多的進(jìn)步，我們會(huì)進(jìn)一步豐富技術(shù)文檔，來(lái)提高 Jenkins 用戶(hù)體驗(yàn)
Jenkins 技術(shù)文檔是我們項(xiàng)目的重要組成部分，因?yàn)樗钦_使用 Jenkins 的關(guān)鍵。好的文檔可以指導(dǎo)用戶(hù)，并鼓勵(lì)選擇好的實(shí)現(xiàn)方式。這是用戶(hù)體驗(yàn)的關(guān)鍵部分。
在最近的 Jenkins UI/UX hackfest 中，文檔是改善 Jenkins 用戶(hù)體驗(yàn)的特定途徑。我們從經(jīng)驗(yàn)豐富的 Jenkins 貢獻(xiàn)者和新人那里獲得了許多進(jìn)步。來(lái)自世界各地的貢獻(xiàn)者提交了有關(guān)安裝，管理和操作 Jenkins 文檔的 PR。
從 Wiki 遷移文檔
Jenkins Wiki 頁(yè)面為 Jenkins 用戶(hù)收集了 15 年的經(jīng)驗(yàn)和智慧。但是，這種經(jīng)驗(yàn)和智慧與不準(zhǔn)確，不完整和過(guò)時(shí)的信息混雜在一起。
Jenkins Wiki 遷移項(xiàng)目確定了 Jenkins Wiki 上訪(fǎng)問(wèn)量最大的 50 個(gè)頁(yè)面，并創(chuàng)建了 GitHub 問(wèn)題來(lái)跟蹤這些頁(yè)面到 www.jenkins.io 的遷移。這是我們第一次使用 GitHub 問(wèn)題作為文檔的大規(guī)模實(shí)驗(yàn)。結(jié)果是壓倒性的正面。Hackfest 貢獻(xiàn)者在許多文檔章節(jié)中添加了新的章節(jié)，包括：
Hackfest 解決了 Wiki 遷移問(wèn)題中的 19 個(gè)問(wèn)題。有關(guān)其他 25 個(gè) Wiki 遷移問(wèn)題的工作正在進(jìn)行中。我們已經(jīng)取得了長(zhǎng)足的進(jìn)步，并期待將來(lái)取得更好的成績(jī)。新的貢獻(xiàn)者非常有效地使用了“good first issues”標(biāo)簽。我們以未分配的 25 個(gè)“good first issues”中的大多數(shù)未分配開(kāi)始了 Hackfest，并以 14 個(gè)已關(guān)閉的項(xiàng)目和另外 10 個(gè)正在進(jìn)行的項(xiàng)目完成了 Hackfest。 當(dāng)我們使用 Jenkins Wiki 遷移來(lái)歡迎新的文檔撰稿人時(shí)，我們將提供更多的“good first issues”。
遷移插件文檔
插件文檔也在過(guò)渡中。自 2019 年 11 月以來(lái)，插件一直將其文檔移至托管插件源代碼的 GitHub 存儲(chǔ)庫(kù)中。這種“文檔即代碼”的方法使插件維護(hù)人員可以在實(shí)現(xiàn)新功能的相同 PR 中包括文檔改進(jìn)。它確保文檔更改由審查和批準(zhǔn)新功能的相同維護(hù)者審查。
Hackfest 參與者提交了 PR，以將插件文檔遷移到 GitHub。Hackfest 正在進(jìn)行 10 個(gè)插件 PR。來(lái)自 Hackfest 的 5 個(gè)插件 PR 已被合并，正在等待插件的發(fā)布。
Chuck Norris 文檔即代碼
出于娛樂(lè)和冒險(xiǎn)的精神，Oleg Nenashev在 2020 年 5 月 26 日的 Hackfest 現(xiàn)場(chǎng)演示中將 “Chuck Norris 插件” 遷移為 GitHub 文檔中的代碼。可以從以下鏈接獲取錄音，插件遷移指南和導(dǎo)出工具的鏈接：將插件遷移為代碼文檔”。
文檔更新
Jenkins 與其他技術(shù)合作，解決了許多不同環(huán)境中的自動(dòng)化挑戰(zhàn)。我們?cè)凇?a target="_blank">解決方案頁(yè)面”中描述了這些環(huán)境。作為 Hackfest 的一部分，我們已經(jīng)對(duì)解決方案頁(yè)面進(jìn)行了一系列改進(jìn)。
Docker 解決方案頁(yè)面現(xiàn)在包括更新的視頻和更好的頁(yè)面布局，以便于閱讀和導(dǎo)航。其他解決方案頁(yè)面將來(lái)也會(huì)得到類(lèi)似的改進(jìn)。
系統(tǒng)屬性
可以在啟動(dòng)時(shí)通過(guò)定義 Java 屬性來(lái)修改 Jenkins 的全局配置。當(dāng)新的默認(rèn)配置可能與現(xiàn)有安裝不兼容時(shí)，系統(tǒng)屬性可以更改系統(tǒng)默認(rèn)值，并可以提供兼容性“轉(zhuǎn)義陰影線(xiàn)”。
Daniel Beck 作為 Hackfest 的一部分，改進(jìn)了系統(tǒng)屬性頁(yè)面的導(dǎo)航和用戶(hù)體驗(yàn)?，F(xiàn)在，通過(guò)將鼠標(biāo)懸停在每個(gè)屬性的右側(cè)以及對(duì)每個(gè)屬性進(jìn)行分類(lèi)和分類(lèi)的標(biāo)簽，可以使用可嵌入的鏈接來(lái)輕松閱讀和引用。
插件站點(diǎn)改進(jìn)
在 Hackfest 期間，Gavin Mogan 繼續(xù)致力于改善 Jenkins 插件站點(diǎn)，以便用戶(hù)可以輕松訪(fǎng)問(wèn)插件更改日志和報(bào)告的問(wèn)題。合并此 PR 后，它將極大地改善那些想要更新插件并查找有關(guān)其變化和可能遇到的問(wèn)題的文檔的 Jenkins 用戶(hù)的體驗(yàn)。
Jira 插件的傳入 UI 示例：
下一步是什么？
Jenkins 文檔中仍有很多工作要做，我們需要您的幫助。參與Jenkins 項(xiàng)目的方式有很多，包括文檔。請(qǐng)參閱貢獻(xiàn)指南以獲取詳細(xì)說(shuō)明。加入文檔聊天室，獲得個(gè)性化的幫助和鼓勵(lì)。
Jenkins 項(xiàng)目也已于今年加入Google Docs。這項(xiàng)開(kāi)源指導(dǎo)計(jì)劃使開(kāi)源社區(qū)和技術(shù)作家社區(qū)聚集在一起，從而使雙方受益。我們正在尋找有興趣為 2020 年 9 月至 12 月對(duì)該項(xiàng)目做出貢獻(xiàn)的技術(shù)撰稿人。這是學(xué)習(xí)作為文檔編碼的工具并了解有關(guān)為開(kāi)源項(xiàng)目做出貢獻(xiàn)的更多信息的絕佳機(jī)會(huì)。您可以在此處找到 Jenkins 項(xiàng)目構(gòu)想和更多信息。
