Spring Framework 參考文件更新

工程 | Rossen Stoyanchev | 2023 年 5 月 11 日 | ...

從 6.0.9 版本開始,Spring Framework 參考文件站點是使用 Antora 生成的。這是一個重大變化,帶來了許多改進。這篇部落格文章提供了相關的背景資訊。

概述

長期以來,Spring Framework 參考文件有兩個版本,一個單頁版和一個多頁版。單頁版非常大,但通常因其透過 Ctrl+F 搜尋的功能而備受青睞。多頁版提供了結構,但難以導航和搜尋。例如,請參見 4.3.x 版本的單頁版多頁版

在 5.0 版本中,我們切換到了單一版本,將文件分成幾個高級別部分,作為單一版本和多頁面版本之間的一種折衷方案。你仍然可以在一個部分內使用 Ctrl+F,而這些頁面中的任何一頁內容都不像完整文件那麼大。在這個版本中,我們還添加了左側導航,以便於內容導航。請參閱 5.3.x 中的示例

然而,理想情況下,內容應該更結構化,擁有更多獨特的 URL,並且易於搜尋。谷歌善於查詢內容,但由於同一內容有多個版本以及隨著時間的推移一些 URL 發生了變化,這可能會變得具有挑戰性。整合搜尋功能是更好的替代方案。

然後還有一些問題,比如這個議題,關於從舊版本到最新版本新增連結,這看起來很簡單,但需要一個更高階的文件網站,它能夠識別多個版本。

這就是 Antora 發揮作用的地方。在過去的幾年裡,Spring 團隊和 Antora 團隊合作建立了一個新的文件釋出系統,以滿足 Spring 專案的需求,包括上述以及現代文件網站所期望的其他功能。

我們剛剛開始使用這個整合,你可以在 https://docs.springframework.tw/spring-framework/reference/ 看到結果。

改進

首先要注意的是右上角的版本選擇下拉選單。我們稍後會回到確切的版本列表,但如果你切換到當前版本之外的版本,你會在頁面頂部看到一個警告,其中包含指向最新版本的連結。

搜尋框,也在右上角,是我個人最喜歡的功能。一個基於 Algolia Docsearch 的整合搜尋功能,讓你無需訴諸谷歌搜尋或載入完整內容即可使用 Ctrl+F,即可在文件中進行搜尋。

注意: 搜尋目前使用的是預設的 Docsearch UI,它只顯示 5 個結果。我們正在積極開發一個自定義 UI,並將在準備就緒時切換到它!

在同一區域,你還會看到一個“編輯此頁面”連結,這使得提交特定頁面的文件更新變得容易。

內容現在已結構化並分解為反映文件結構的唯一 URL。主內容的左側是全域性導航,右側是區域性導航,頂部還有面包屑導航。

還有更多不那麼明顯的好處。例如,文件更改不依賴於下一個釋出,而是立即部署到文件中。

版本

6.0.x 分支和主分支(目前是 6.1.x)已遷移到 Spring Antora 整合,文件網站包含這些版本。我們不打算遷移以前的版本,而且無論如何,目前唯一活躍的其他分支是 5.3.x。

現有的 6.0.x、6.1.x 和“current”參考文件連結已透過永久重定向重定向到新的參考文件。

其他 Spring 專案呢?

Spring Security 已經使用 Antora 一段時間了。我們也計劃遷移其他專案。還有計劃不僅在版本之間,而且在 Spring 專案之間進行進一步的整合。

更多資訊

敬請關注未來幾周內釋出的另一篇部落格文章,它將深入探討所有這些內容。

獲取 Spring 新聞通訊

透過 Spring 新聞通訊保持聯絡

訂閱

領先一步

VMware 提供培訓和認證,助您加速進步。

瞭解更多

獲得支援

Tanzu Spring 提供 OpenJDK™、Spring 和 Apache Tomcat® 的支援和二進位制檔案,只需一份簡單的訂閱。

瞭解更多

即將舉行的活動

檢視 Spring 社群所有即將舉行的活動。

檢視所有