Синхронизация с GitHub

Valoryx Cloud может синхронизировать вашу документацию с репозиторием GitHub. Это даёт лучшее из двух миров: красивый веб-редактор И всю мощь git.

Зачем подключать GitHub?

  • Резервное копирование — ваша документация всегда в безопасности в GitHub, даже если вы удалите аккаунт
  • Редактирование в IDE — разработчики в вашей команде могут редактировать документацию в VS Code, Vim или любом другом редакторе
  • Pull requests — используйте рабочий процесс PR в GitHub для ревью документации перед публикацией
  • История версий — полный git blame, diff и откат для каждого изменения
  • CI/CD-интеграция — запускайте сборки или тесты при изменении документации

Как это работает

Вы редактируете в браузере → автосохранение → автокоммит → push в GitHub
                                                              ↕
Коллега пушит из IDE → GitHub → webhook → pull в Valoryx

Изменения передаются в обоих направлениях автоматически. Вам не нужно думать о синхронизации.

Настройка

  1. Перейдите в Workspace Settings → Git Sync
  2. Нажмите Connect GitHub
  3. Авторизуйте Valoryx для доступа к вашим репозиториям
  4. Выберите репозиторий и ветку для синхронизации
  5. Готово — ваше рабочее пространство подключено

Что синхронизируется

Каждая страница в вашем рабочем пространстве соответствует файлу .md в репозитории:

your-repo/
├── getting-started.md
├── api/
│   ├── authentication.md
│   └── endpoints.md
├── guides/
│   ├── deployment.md
│   └── troubleshooting.md
└── .docplatform.yaml     ← метаданные рабочего пространства

Обязательно ли подключать GitHub?

Нет. Синхронизация с GitHub полностью опциональна. Valoryx Cloud прекрасно работает и без неё. Ваша документация надёжно хранится на наших серверах. GitHub добавляет резервное копирование и доступ через IDE — но он не требуется для работы ни одной функции.