Как поддержать изменения в старых версиях документов, поддерживаемых docusaurus - PullRequest
0 голосов
/ 28 декабря 2018

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

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

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

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

Кроме того, документация Docusaurus гласит следующее:

Функциональность отката

Только файлы вфайлы каталога и боковой панели документов, отличающиеся от файлов последней версии, будут копироваться каждый раз при указании новой версии.Если между версиями нет изменений, 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#fallback-functionality

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

1 Ответ

0 голосов
/ 08 января 2019

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

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

...