OCaml.org 新闻通讯:2023年6月

欢迎阅读 2023 年 6 月版的 OCaml.org 新闻通讯!与上一次更新一样,本期由 @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 优秀的“Are we web yet?”页面

如 Pull Request 中所述,这些页面的目标有三方面

  • 对于新手,它提供了 OCaml 在特定应用中的可用性的概述。
  • 对于 OCaml 用户,它可以帮助发现用于执行特定任务的库和框架。
  • 对于社区成员,它可以作为路线图,让我们专注于解决特定痛点,使 OCaml 在特定用例中与其他语言竞争。

我们已经与社区和与 Web 开发相关的包的作者进行了沟通,并在 Pull Request 上收到了宝贵的反馈。

接下来,我们计划将工作重点放在单个“OCaml 是否已支持 Web?”页面上,并分别处理其他页面。我们将继续探索生态系统,并合并该页面的初始版本,我们旨在持续改进该版本以反映 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 上的博客聚合器,并在其中两个中发现了一些错误的 URL。-- #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-表达式、YAML 和 HTML)的文档中提取超链接,并检查给定的 URL 是否以 HTTP 状态 200 响应。-- #1345