Ведение и сборка документации#

Термины#

Argo Workflows — это контейнерный движок рабочих процессов в среде Kubernetes. Argo Workflows является частью продукта GetDocs, и все workflow, определенные в нем, имеют отношение к обработке документации.

Workflow — это главная сущность Argo Workflows, определяющая порядок действий для выполнения рабочего процесса и сохранение его состояния (аналог Jenkins job).

Работа с workflows#

Примечание

  • Получите ссылку для входа в Argo Workflow у системного администратора.

  • В поле NAMESPACE (пространство имен) должно быть указано значение getdocs, при другом значении возможна ошибка с запретом доступа.

Чтобы посмотреть список workflow, перейдите на страницу Workflows:

Страница Workflows

Чтобы отфильтровать список по создателю workflow, в поле LABELS укажите либо workflows.argoproj.io/creator-email=<почта-пользователя>, либо workflows.argoproj.io/creator-preferred-username=<логин-пользователя>:

Порядок запуска workflows#

Полный цикл работы с комплектом документации включает в себя следующие шаги:

  1. Подготовка репозитория документации к дальнейшей работе с workflows.

  2. Запуск workflow build-doc, который выполняет предварительную сборку и валидацию документации из исходных файлов в репозитории.

  3. Проверка отчета сборки и исправление ошибок сборки при необходимости.

  4. Внесение кода и версии успешно собранного комплекта документации в конфигурацию сайта.

  5. Запуск workflow build-site, который отобразит на статическом сайте и в приложении сайта добавленный в конфигурацию комплект.

  6. (Опционально) Запуск workflow load-to-nexus для сборки архива с документацией и его загрузки в Nexus.

На любом этапе можно воспользоваться workflows проверки качества контента для валидации исходных файлов документации в репозитории:

Запуск workflow#

Workflow можно создать двумя способами - на странице Workflows или на странице Workflow Templates.

Workflows#

  1. Перейдите на вкладку Workflows.

  2. В поле NAMESPACE укажите getdocs.

  3. Нажмите кнопку SUBMIT NEW WORKFLOW.

  4. Выберите нужный workflow из списка:

    Создание нового workflow

  5. В появившейся форме не изменяйте поля Entrypoint и Labels, остальные заполните согласно описанию (появляется при наведении курсора на знак вопроса рядом с названием поля).

  6. Нажмите кнопку SUBMIT.

    Запуск нового workflow

Workflow Templates#

  1. Перейдите на вкладку Workflow Templates.

  2. В поле NAMESPACE укажите getdocs.

  3. Выберите нужный workflow из списка:

    Создание нового workflow template

  4. Нажмите кнопку SUBMIT в интерфейсе шаблона.

  5. В появившейся форме не изменяйте поля Entrypoint и Labels, остальные заполните согласно описанию (появляется при наведении курсора на знак вопроса рядом с названием поля).

  6. Нажмите кнопку SUBMIT.

    Запуск нового workflow template