欢迎Yari:MDN Web Docs有一个新平台

2020-12-15 21:33:26

经过数月的艰巨工作,进行了如此重大的更改,今天终于到了:MDN Web Docs的新平台(代号Yari)终于启动了!

在11月2日至12月14日之间,我们进行了一个Beta测试,在此期间,我们许多出色的社区成员测试了新平台,提交了内容更改,允许我们尝试新的贡献工作流程,并提出了对平台和样式的改进建议。所有人都由衷的感谢。

这篇文章旨在提供有关我们现在的位置,下一步的目标以及您可以提供帮助的最新信息。

我们在很短的时间内就建立了一个工作系统,该系统在以前的平台上有了很大的改进,并解决了许多明显的问题。当然,还有很多工作要做,但是这个新版本为迭代提供了一个稳定的基础,并且在接下来的几个月中,您将看到很多进一步的改进。这是我们现在的位置:

新平台最重要的区别是我们将内容从SQL数据库分散到了git存储库中的文件中。要编辑内容,您现在可以针对https://github.com/mdn/content仓库提交拉取请求,而不是使用旧的WYSIWYG编辑器来编辑Wiki。

就贡献工作流而言,这具有巨大的优势-因为它是GitHub仓库,您可以将其插入工作流中,但是您感到舒适,更容易以编程方式进行大量更改,并且可以一次拖动将多个页面上的编辑集中在一起请求而不是分散的个人编辑,我们可以对编辑应用智能自动整理功能,以加快工作速度。

内容库最初带有一些基本的CLI工具,可帮助您完成基本任务,例如:纱线启动(创建在MDN上呈现时文档的实时预览),纱线内容创建(添加新页面) ),纱线含量的移动(以移动现有页面)等。您可以在仓库的README文件中找到这些的更多详细信息以及其他贡献说明。

社区互动不仅会得到改善,而且会转变。现在,您可以就拉动请求的更改进行最终确定和提交之前进行对话,提出建议并进行迭代,而不必担心第一次就完美完成。

我们认为,该模型将使贡献者在进行更改时更有信心,并使我们能够与社区建立更好的关系并帮助他们提高贡献。

此更新现在也大大减轻了我们开发人员的维护负担。现有的(Kuma)平台非常复杂,难以维护,而且很难添加新功能。该更新将极大地简化平台代码-我们估计我们可以删除现有代码库的很大一部分,这意味着更易于维护和贡献。

我们的前端架构也是如此:现有的MDN平台存在许多前端不一致和可访问性问题,我们希望在一段时间内解决这些问题。转向新的简化平台为我们提供了解决此类问题的绝好机会。

我们可以做很多事情来进一步完善新平台。例如,上周,我们已经讨论了我们对MDN的110亿美元未来的计划。

在新的一年中,我们要做的第一件事就是消除新平台中的缺陷。之后,我们可以开始比以前更好地为我们的读者和贡献者提供服务,更快,更自信地实现新功能,这将带来更有用的MDN和更强大的贡献模型。

以下各节并非绝对明确,但确实提供了有关我们接下来针对该平台计划的有用信息。我们的目标是将来发布公共路线图,以便您可以找到我们的位置并提出建议。

在启动时,内容以HTML格式存储。可以-我们都知道一些HTML-但这不是最方便编辑和编写的格式,尤其是当您从头开始创建相当大的新页面时。大多数人发现Markdown比HTML更容易编写,因此我们最终希望将自己的核心内容存储在Markdown(或其他某种格式)中,而不是HTML。

长期以来,搜索功能在MDN上一直不合格。展望未来,我们不仅要升级搜索以返回有用的结果,而且还希望搜索更加有用,例如模糊搜索,按标题按受欢迎程度搜索,摘要,全文搜索等等。

目前,我们的新内容仓库中仅表示MDN内容页面。我们最终希望停止使用旧的主页,个人资料和搜索页面,而这些页面目前仍可以在基于Django的旧平台上使用,并将它们带入新平台,并带来所有优势。

逐渐删除保留在MDN内容中的旧式KumaScript宏,然后适当地删除,呈现或替换它们。例如,链接宏只能呈现出来,因为标准HTML链接可以正常工作,而我们拥有的所有侧边栏宏都应替换为内置在实际平台中的适当侧边栏系统。

正如您从上述后续步骤中看到的那样,还有很多事情要做,我们希望社区能够帮助我们将来的MDN内容和平台工作。

如果您对帮助内容工作更感兴趣,可以在“贡献到MDN”中找到如何提供帮助。

如果您对帮助MDN平台开发更感兴趣,那么学习入门的最佳地点是Yari README。

关于找到一个有关MDN的一般聊天场所,您可以在Matrix的MDN Web Docs聊天室中加入讨论。