Как поддержать изменения в старых версиях документов, поддерживаемых docusaurus

Я пробую инструмент Docusaurus для создания сайта документации. Пока все ок, пока не дошел до Управление версиями.

Я так понимаю:

  1. Все, что находится на вашем /docs/**/*.md, - это ваши последние документы для выпуска следующий
  2. Предыдущие версии ваших документов доступны в каталоге /website/versioned-docs/version-${version-number}.

Что мне непонятно, так это то, как мне поддерживать / публиковать изменения в предыдущих версиях? Мои изменения в каталоге /docs/** еще не готовы к публикации. Итак, каков механизм сохранения изменений в более старых версиях документов?

Также в документации Docusaurus сказано следующее:

Fallback Functionality

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

For example, a document with the original id doc1 exists for the latest version, 1.0.0, and has the same content as the document with the id doc1 in the docs directory. When a new version 2.0.0 is created, the file for doc1 will not be copied into versioned_docs/version-2.0.0/. There will still be a page for docs/2.0.0/doc1.html, but it will use the file from version 1.0.0.

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

Итак, предположим, что теперь мне нужно поддерживать / обновлять документ предыдущей версии, но этот файл не был дублирован, потому что на момент создания новой версии в этом конкретном файле не было никаких изменений. Итак, каков процесс? Могу ли я вручную скопировать необходимый файл в каталог /website/versioned-docs/version-${version-number}, а затем внести свои изменения?

🤔 А знаете ли вы, что...
JavaScript был первоначально создан для улучшения интерактивности веб-страниц.


3
262
1

Ответ:

Сопровождающий Docusaurus здесь. Из-за того, как реализовано управление версиями, нет простого способа обновить предыдущие версии в V1. Возможно, вы не захотите обновлять предыдущие версии, поскольку версия должна быть заморожена при публикации, а обновления должны выполняться до новых версий.

Но если вы настаиваете, вы всегда можете отредактировать сгенерированные файлы в каталогах versioned_docs/version-X.X.X. Тем не менее, я бы рекомендовал внести изменения в последнюю версию и рекомендовать вашим пользователям обновиться до последней версии.