如何支持由Docusaurus维护的旧版本文档中的更改

3

我正在尝试使用Docusaurus工具创建文档网站。到目前为止,一切都还好,直到我遇到了版本控制

我的理解是:

  1. /docs/**/*.md中的所有内容都是下一个发布版本的最新文档
  2. 您的文档的早期版本可以在/website/versioned-docs/version-${version-number}目录中找到

对我来说不清楚的是如何维护/发布以前版本的更改?我在/docs/**目录中的更改还没有准备好发布。那么,如何维护旧版文档的更改机制是什么?

Docusaurus的文档还说:

回退功能
每次指定新版本时,只有位于docs目录和侧边栏文件中与最新版本不同的文件才会被复制。如果在不同版本之间没有变化,则Docusaurus将使用该文件的最新版本。
例如,对于最新版本1.0.0存在具有原始ID doc1的文档,并且其内容与docs目录中具有ID doc1的文档相同。当创建新版本2.0.0时,将不会将doc1的文件复制到versioned_docs/version-2.0.0/中。仍将存在一个页面用于docs/2.0.0/doc1.html,但它将使用来自版本1.0.0的文件。

https://docusaurus.io/docs/en/versioning#fallback-functionality

假设我现在需要维护/更新先前版本的文档,但该文件没有被复制,因为在创建新版本时,这个特定文件没有任何更改。那么,流程是什么?我需要手动将必要的文件复制到 /website/versioned-docs/version-${version-number} 目录中,然后进行更改吗?


1
所以,看起来下一个版本(V2)将解决我的担忧,即在创建新版本时,如果文件与上一个版本没有变化,则不会保存。https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2 - aver
1个回答

0

我是Docusaurus的维护者。由于版本控制的实现方式,V1中没有简单的更新先前版本的方法。您可能不想更新以前的版本,因为版本应该在发布时被冻结,并且更新应该针对新版本进行。

但是,如果您坚持要更新,请随时编辑versioned_docs/version-X.X.X目录下生成的文件。然而,我建议您对最新版本进行更改,并鼓励用户升级到最新版本。


1
谢谢@yangshun的回复。是的,我也意识到我们可以编辑versioned_docs/version-X.X.X目录下的文件。但是,如果我需要在该版本下添加新文件怎么办?yaml前置元数据原始id字段值会是什么?我认为文档版本不应该被冻结。也许第一次文档不清楚或需要提供当时不可用的附加文档。因此,虽然特定版本的源代码应该被冻结,但我认为相关文档始终可以更改。 - aver

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接