Изменить расположение пользовательской документации

При обращении к документации из программ Windows-клиент и Web-клиент, пользователь по умолчанию будет направлен на сайт документации Docsvision.

При необходимости администратор может разместить документы на ресурсах своей организации. Для этого необходимо изменить шаблон, по которому определяется расположение документации. Расположение пользовательской документации можно изменить через графический интерфейс Консоли управления Docsvision, см. подробнее ниже.

Шаблоны расположения документации

Перейдите на страницу Серверы  Имя-сервера  Сервер приложений  Общие настройки. Укажите расположение документации в поле Адрес сайта документации.

В поле могут быть использованы переменные:

  • {client} — псевдоним клиентской программы, который может приобретать значения:

    • winclient — для Windows-клиента.

    • webclient — для Web-клиента.

      Другие клиентские приложения не поддерживают настройку, определяющую расположение документации.

  • {version} — версия клиентской программы.

Таким образом фактический стандартный адрес документации, к примеру, для модуля Платформа версии 6.2 будет следующим: http://help.docsvision.com/platform/6.2/.

Для всех клиентских программ используется общий шаблон, поэтому размещать документацию Windows-клиента и Web-клиента следует на одном сайте.

Требования к сборке сайта документации

Документация Docsvision разворачивается с помощью генератора статических сайтов Antora. Документация может быть развёрнута локально, в таком случае потребуется изменить адрес документации в файле antora-playbook.yml.

Требования для сборки сайта:

  • Доступ к сайту Github или иной доступ к репозиториям исходного кода документации Docsvision.
    Репозитории документации обозначены префиксом antora-. Полный список источников указан в файле antora-playbook.yml репозитория antora-playbook.

  • Установлен git.

  • Установлен Node.js версии, указанной в разделе "Требования" на сайте документации Antora.

  • Доступ к локальной копии репозитория Docsvision/antora-playbook/.

Сборка и разворачивание документации:

  1. Откройте командную строку с расположением в корне репозитория Docsvision/antora-playbook/

  2. Установите Antora командой:

    npm i

  3. Запустите сборку сайта при помощи Antora, выполнив следующую команду:

    npx antora antora-playbook.yml

  4. Файлы сайта будут расположены в папке wwwroot.

Просмотр сайта

Сайт можно просматривать:

  • Локально — нажмите на сгенерированные html-файлы, расположенные в папке wwwroot.

  • С простого http-сервера — выполните шаги, указанные в инструкции Antora.

  • Иным способом. В результате сборки сайта формируются файлы в формате .html, которые могут доставляться любым удобным способом.

Ограничения

После сборки сайта некоторые функции окажутся недоступны:

  • Поиск по сайту.

  • Просмотр страниц накопительных обновлений.

Чтобы воспользоваться функциями локального (офлайн) поиска, рекомендуется использовать расширение Antora Lunr Search. Подробная инструкция по разворачиванию приведена в документации расширения.