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

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

Мое понимание таково:

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

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

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

Резервная функциональность

Только файлы в каталоге docs и файлах боковой панели, которые отличаются от файлов последней версии, будут копироваться при каждом указании новой версии. Если нет изменений между версиями, Docusaurus будет использовать файл из последней версии с этим файлом.

Например, документ с исходным идентификатором doc1 существует для последней версии 1.0.0 и имеет такое же содержимое, что и документ с идентификатором doc1 в каталоге docs. При создании новой версии 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

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

1 ответ

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

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

Другие вопросы по тегам