Руководство по интеграции

Это руководство описывает способы интеграции документации Docs-as-Code Portfolio с внешними инструментами и сервисами.

Подключение к CI/CD

Документацию можно автоматически собирать и публиковать при каждом изменении. Пайплайн уже настроен в .github/workflows/build.yml.

GitHub Actions

При пуше в ветку main пайплайн автоматически:

1. Устанавливает Python-зависимости.
2. Запускает markdownlint для проверки стиля.
3. Собирает сайт через mkdocs build.
4. Публикует результат в site/.

- name: Build documentation
  run: mkdocs build

Интеграция с Docker

Образ для сборки определён в Dockerfile. Используйте его в своих процессах:

docker build -t docs-portfolio .
docker run --rm -v $(pwd):/app docs-portfolio build

Публикация на внешний хостинг

Готовый сайт из папки site/ можно опубликовать на любой статический хостинг:

• GitVerse Pages / SourceCraft Sites — через конфигурацию .sourcecraft/sites.yaml.
• GitHub Pages — через peaceiris/actions-gh-pages.
• Netlify / Vercel — подключив репозиторий как источник.

Вебхуки и уведомления

Вы можете настроить уведомления о статусе сборки документации через вебхуки GitVerse или GitHub — например, в Telegram или Slack.

Что дальше?

• Руководство по устранению неполадок — решение частых проблем.
• Руководство по настройке — конфигурация системы.
• API Reference — документация REST API.