Github
Mintlify terintegrasi dengan API GitHub, memungkinkan sinkronisasi antara dokumentasi Anda dan repositori GitHub Anda. Integrasi ini dimungkinkan melalui penggunaanGitHub Apps.
Instalasi
Untuk memulai, Anda perlu menginstal Mintlify GitHub App ke akun GitHub tempat repo dokumentasi Anda berada. Menginstal GitHub App memerlukan kepemilikan organisasi atau izin admin dalam repositori. Jika Anda tidak memiliki izin yang diperlukan, pemilik repositori perlu menyetujui permintaan tersebut. Anda dapat mengakses halaman instalasi dengan masuk kedashboard Mintlify.
Untuk GitHub Apps, Anda dapat memilih untuk hanya memberikan izin ke satu repositori saja. Kami sangat menyarankan Anda melakukannya karena kami hanya membutuhkan akses ke repositori tempat dokumentasi Anda di-host.
Izin
Ketika Anda menginstal aplikasi GitHub, Anda akan diminta untuk memberikan izin berikut:
- Baca akses ke
metadata - Baca dantulis akses ke
checks,code,deployments,pull requests, danworkflows
Izin-izin ini dimanfaatkan untuk memberikan pengalaman yang mulus saat mengelola dokumentasi Anda.
Ketika Anda membuat commit ke branch yang Anda konfigurasi sebagai branch deployment dokumentasi, kami mengambil isi dari file-file yang berubah untuk memperbarui dokumentasi Anda. Untuk mencapai ini, kami memerlukan akses baca kecontents.
Ketika pull request dibuat, kami membuat pemeriksaan dan preview deployment, itulah mengapa kami memerlukan akses tulis kechecks dandeployments.
Di dalam editor web Mintlify, Mintlify bekerja atas nama Anda untuk membuat branch dan pull request, itulah mengapa kami memerlukan akses tulis kepull requests dan
workflows.
Jika Anda khawatir tentang izin tulis, Aplikasi GitHub hanya akan memiliki akses ke repo-repo yang Anda berikan aksesdan jika Anda memiliki perlindungan branchtidak dapat push langsung ke branch Anda - ini mematuhi aturan perlindungan branch Anda.
Instalasi Repositori
Saat menginstal aplikasi GitHub kami, Anda akan diminta untuk memilih semua repositori atau subset dari mereka. Pilihan ini dapat diubah kapan saja dengan pergi ke pengaturan aplikasi GitHub.