返回新聞

OCaml.org 電子報：2023 年 6 月

歡迎來到 OCaml.org 電子報 2023 年 6 月份的版本！如同先前的更新，本次內容由 @sabine 和 @tmattio 彙整。

OCaml.org 電子報概述了 OCaml.org 網站上的變更，並讓您一窺幕後發生的事情。您可以在此處找到過往版本的列表。

我們的目標是讓 OCaml.org 成為任何想要開始使用 OCaml 並提高生產力的人的最佳資源。若沒有所有出色的 OCaml 社群成員協助我們審閱、修改和建立更好的 OCaml 文件，我們不可能做到這一點。您的回饋使我們能夠更好地確定工作優先順序，並朝著我們的目標邁進。謝謝！

我們在本月的工作分為三個部分呈現：

  • 學習區塊： 我們正努力使 OCaml.org 成為學習 OCaml 並探索其生態系統的絕佳資源。本月，我們持續進行新的學習區塊的線框圖和設計。我們也專注於編寫新的文件，其中包括關於 Dune 和 S-Expressions 的幾個教學。
  • 治理頁面： OCaml 平台團隊正努力使決策過程和持續開發更透明且社群驅動（包括OCaml 平台路線圖的工作）。為了支持這項倡議，我們正在開發一個治理頁面，列出 OCaml 組織的團隊和維護者。
  • 一般改進： 如往常一樣，我們也進行了一般維護和改進，並在本電子報中重點介紹其中一些內容。

學習區塊

1. 學習區塊的重新設計

上個月，我們基於使用者回饋，開始進行新的學習區塊的線框圖和設計。

本月，我們修改了學習區塊首頁的線框圖和設計，並隨後為其他必要的頁面建立了線框圖，包括「開始使用」、「語言」、「教學」、「練習」、「書籍」和「搜尋結果」。我們也與 OCaml.org 團隊舉行了一次互動會議，以審閱和修改線框圖。

在本月底，我們也分享了更新的設計，以獲得社群的回饋。

正在進行中的設計可於 Figma 上存取。

下個月，我們將根據收到的回饋，繼續改進設計，並開始發送 Pull Request 以實作 UI。

2. OCaml 文件

除了重新設計學習區塊外，我們的工作還包括全面修訂文件內容，以及建立新的文件。

上個月，我們完成了序列和錯誤處理教學。

本月，我們與 OCaml.org 團隊舉行了一次關於編寫新文件的研討會，以啟動更多文件頁面的建立。撰寫新教學大綱的合作被證明是有幫助的，因此我們計畫定期舉辦研討會。我們也計畫向社群開放這些研討會。敬請期待！

我們建立了一個關於「檔案操作」的全新教學，該教學即將進入社群審閱階段。此外，我們還撰寫了一個新的「Dune」教學和一個新的「S-Expressions」教學，並為「基本資料型別」和「值與函式」教學建立了大綱。

3.「OCaml X 了嗎？」頁面

作為我們在新的學習區塊上的工作的一部分，我們開始探索新增「OCaml X 了嗎？」頁面，其靈感來自 Rust 出色的「我們有網頁了嗎？」頁面。

如 Pull Request 中所述，這些頁面的目標有三個：

  • 對於新手來說，它可以概述 OCaml 在某些應用中的可用性。
  • 對於 OCaml 使用者來說，它可以幫助他們發現執行某些任務的函式庫和框架。
  • 對於社群成員來說，它可以作為一個路線圖，將我們的努力集中在解決特定的痛點上，以使 OCaml 在特定使用案例中與其他語言競爭。

我們已經與社群和與 Web 開發相關的套件作者進行了交流，並收到了關於 Pull Request 的出色回饋。

接下來，我們計畫將工作重點放在單一的「OCaml 有網頁了嗎？」頁面上，並分別處理其他頁面。我們將繼續探索生態系統，並合併該頁面的初始版本，我們的目標是不斷改進該版本，以反映 OCaml 中的 Web 開發狀態。

4. 準備將 opam 文件移至 OCaml.org

我們致力於將 opam 文件移至學習區塊「平台工具」頁面下的修補程式。

這背後的意圖是讓 opam.ocaml.org 上公開可見的網站退役，因為我們現在在 ocaml.org 上有一個集中化的套件文件目錄。

opam 手冊的長期計畫是透過套件文件管道產生它。然而，為了實現這一點，opam 手冊需要移植到 odoc。正如 OCaml 平台電子報中所見，odoc 團隊目前正致力於改進 odoc 的功能，以建立豐富且易於瀏覽的手冊。

朝著更透明的 OCaml 治理邁進

在 5 月，我們合併了一個 PR，該 PR 擴展了 OCaml.org 治理政策，以包含 OCaml 平台的治理，包括其生命週期和每個階段的要求。

本月，我們致力於新的治理頁面，其中列出了生態系統的團隊和維護者。

主要挑戰在於準確地列出每個專案的維護者，並持續更新。為此，我們正在討論使用 GitHub 團隊，以取得每個專案的最新維護者列表。

一般改進

本月，我們在一般維護和改進方面做了很多工作！

請查看以下相關的 PR 和活動列表，以了解我們的重點。

相關的 PR 和活動

  • 我們為 OCaml 首頁設計了橫幅，並宣布 OCaml 獲得的 ACM SIGPLAN 獎項。-- #1327
  • 我們開始研究如何將套件載入 OCaml Playground 中。
  • 我們現在可以識別並在主要首頁上顯示 OCaml 的長期支援版本（目前為 4.14.1），並且發布區塊已從學習區塊移至主要首頁。-- #1277 & #1313
  • 我們從 v2.ocaml.org 新增了 55 個 RSS 提要到 ocaml.org 上的部落格彙整器，並發現其中兩個提要中的網址有誤。-- #1329
  • 我們透過整理 Tailwind 設定、為顏色賦予更語義化的名稱以及將重複的 HTML 分解為元件，在 ocaml.org 的暗色模式方面取得了一些進展。-- #1350
  • 我們開始致力於在 ocaml.org 上啟用部落格的標籤篩選。我們徵求了社群對首選篩選器/標籤的意見。
  • 我們致力於改進文件管道，特別是工具 voodoo，方法是移除無用的舊版程式碼，並最佳化偵測 README、LICENSE 和 CHANGELOG 檔案的流程，目的是減少 ocaml.org 對於 docs-data.ocaml.org 發出的 HTTP 請求數量。
  • 建立了一個新的連結檢查工具 tarides/olinkcheck。將此工具與套件文件管道整合的作業正在進行中，並且已將執行 tarides/olinkcheck 的工作流程新增至 GitHub 儲存庫。此工具會從支援格式純文字、S-expressions、YAML 和 HTML 的文件中擷取超連結，並檢查給定的 URL 是否以 HTTP 狀態碼 200 回應。-- #1345