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

Valoryx Cloud може синхронізувати вашу документацію з репозиторієм GitHub. Це дає вам найкраще з обох світів: гарний веб-редактор І повну потужність Git.

Навіщо підключати GitHub?

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

Як це працює

Ви редагуєте у браузері → автозбереження → автокоміт → push до GitHub
                                                        ↕
Колега робить push з 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 — але це не є вимогою для роботи жодної функції.