开发者救星:Docusaurus
在德国达姆施塔特的一家酒店会议室,一小群 Joomla 爱好者开始接触 Docusaurus,驯服这个巨兽,使其对 Joomla 开发者社区有利。这个整洁的软件包可能是 Joomla 文档很长时间以来最重要的变化,而且还有额外的好处,那就是永远消灭了令人讨厌的 MediaWiki 验证码!
于2022年7月24日在德国达姆施塔特组成的团队包括
Benjamin Trenkle (DC Production),Philip Walton (DC Outreach),Mike Brandner (TL JDocs Team),Christiane Maier-Stadtherr (TL Joomla Accessibility Team),Viviana Menzel (TL Accessibility Team),以及在线的 Shivam Rajput (TL Enhancement Development Team and Google Summer of Code Joomla Team),还有在线的 Harald Leithner (DC Operations)。
会议有几个关键目标
- 在JDocs的未来中找到清晰的思路,
- 为Google Season of Docs申请做准备
- 了解新的开发者文档软件并使其运行。
为GSoD规划项目
为GSoD规划的项目被提出并讨论。
开发者的文档是第一个项目。今年早些时候曾经尝试解决这个问题,但没有继续下去。我们需要一个解决方案。
Harald 介绍了 Docusaurus 2,这是一个来自 Meta 的开源工具,可在 GitHub 上找到,支持版本化文档。
普遍认为这是一个开始编写新特性文档的非常好的工具。
GitHub: https://docusaurus.org.cn/
第二个项目是为 Joomla! 用户编写的用户友好的文档,“Joomla 用户指南”。Joomler 用户有很多反馈。许多人发现当前的 JDocs 太复杂,难以使用,门槛相当高,不利于自学。找到合适的文档,从外部来源提供正确的答案也很困难。
对于这个第二个项目,我们决定创建一个独立的网站作为用户友好的文档来源。这并不意味着JDocs with MediaWiki的终结,只是另一个包含类似Joomla用户手册内容的网站。结构清晰,只包含支持版本的文档。
对于这两个项目,都创建了GSoD 2023的JDoc页面,并填写了初始信息:https://docs.joomla.org/GSoD_2023
我们的想法是获得GSoD的拨款来资助技术文档编写者。他们将在此后推动项目进展,并得到项目导师的支持。往往,势头会耗尽,因此这种做法有望弥合需求和现实之间的差距。
主要研讨会
在接下来的研讨会上,解释了新的Joomla!开发者文档,房间里的所有人开始一起设置。本杰明帮助解决了技术问题,但系统很简单。创建了初始结构;请参阅:https://github.com/joomla/Manual
一个很好的功能是文档是用标记编写的,并通过GitHub管理,这对于开发者来说比MediaWiki更直观。
为了保持开发者文档的更新,还计划要求从Joomla 4.3开始,每项特性PR都需要在合并前有Dev Docs条目。良好的文档缺失一直是许多软件项目的诅咒,Joomla也不例外。为了解决这个问题,我们需要像对待文档一样认真对待文档。
讨论了“Joomla用户指南”项目的计划。目前还没有关于将使用的平台的具体计划,我们欢迎建议。一个想法是使用Joomla作为平台;也许有更适合的工具,我们欢迎反馈。
翻译的处理可以通过Crowdin管理,因此我们已经有了一个管理此内容的既定系统。
在活动即将结束时,讨论转向了Joomla文档应该去哪里。在我们的讨论中,很明显,现有的JDocs应该被维护和运营为社区文档平台。帮助页面已经设置好了,所以我们不能改变太多,尽管可能会有计划自动化一些流程。
迫切需要的是用户可以用来轻松找到路径的文档。这是我们希望通过“Joomla用户指南”走的道路。
你在计划中的角色
这将涉及大量工作,我们将需要许多贡献者,所以请考虑分配一些你的时间。如果你曾经因为缺乏文档而受苦,那么现在是理想的时刻站出来帮助解决这个问题,这样其他人就不会有同样的麻烦。
如果你想支持该项目,请随时联系JDocs团队或通过Glip或发送邮件直接消息到
假期过后将安排更多会议。
发表在Joomla社区杂志上的某些文章代表了作者对特定主题的个人意见或经验,可能不符合Joomla项目的官方立场。
通过接受,您将访问由 https://magazine.joomla.net.cn/ 外部第三方提供的服务
评论 1
早上好,
我需要获取满足一定条件的项目(文章)。我一直在查看端点,我只看到一个可以获取所有文章列表的端点,还有一个可以按ID获取单个文章的端点。
我尝试发送带有参数的查询,但无法获取过滤后的结果
是否有任何端点可以发送带有参数(例如,标题包含某个单词的文章)
感谢您的帮助
问候