Документация EasyDocs в этом репозитории#

Исходники руководства лежат в docs/. В CI (файл .github/workflows/easydocs-static.yml, синтаксис GitHub Actions — тот же используется на GitVerse) выполняется:

1. Сборка Hugo: docs/ → data/easydocs/guide/ (в CI и в docker compose --profile prepare используются абсолютные пути /src/docs и /src/data/easydocs/guide), baseURL /docs/easydocs/guide/.
2. Сборка портала: data/portal/ → data/portal/public/.
3. При пуше в master — коммит артефактов; каталог data/easydocs/guide/ в .gitignore, в workflow выполняется git add -f data/easydocs/guide, чтобы закоммитить сборку. Локально то же даёт хук scripts/hooks/pre-push (установка: bash scripts/install-git-hooks.sh).
4. Секрет GITVERSE_TOKEN (или встроенный токен раннера) — если нужен push в remote.

Так в стандартной поставке всегда есть актуальная собранная статика руководства и портала.

Перенос на другой Git-хостинг#

YAML workflow использует общие шаги actions/checkout, docker run peaceiris/hugo:v0.146.4-full и git commit. На GitHub Actions достаточно перенести файл в .github/workflows/ и задать аналогичный секрет (например GITHUB_TOKEN с правами contents: write или PAT).

Документация продуктов#

Шаблоны для отдельного репозитория продукта:

• ci-templates/gitlab-ci.yml — GET /v1/build-config (готовый baseURL для Hugo) → сборка → ZIP → POST /v1/publish.
• ci-templates/github-actions-product-docs.yml — то же для GitHub Actions / GitVerse (исходники Hugo по умолчанию в ./docs/).

На хабе должен быть задан PUBLISH_HUB_PUBLIC_URL (как пользователи открывают портал в браузере).

Секрет CI: PUBLISH_API_TOKEN. Переменные: PUBLISH_API_URL, DOCS_HOST, PRODUCT_SLUG, DOC_TYPE, PORTAL_PRODUCT_NAME, PORTAL_DOC_TITLE (см. комментарии в шаблонах и CONFIGURATION.md в репозитории хаба).