Kami menggunakan kombinasi token Akses dan Webhook untuk mengautentikasi dan menyinkronkan perubahan antara GitLab dan Mintlify.

  • Kami menggunakan token Akses untuk mengambil informasi dari GitLab.
  • Kami menggunakan Webhook agar GitLab dapat memberi tahu Mintlify ketika perubahan dilakukan.
    • Ini memungkinkan Mintlify untuk membuat deployment pratinjau ketika MR dibuat.

​
Atur koneksi

1

Temukan ID proyek Anda

Dalam proyek GitLab Anda, navigasikan keSettings>Generaldan temukanProject ID.

2

Buat token akses

a. Navigasikan keSettings>Access Tokens.

b. PilihAdd new token.

  1. Beri nama token “Mintlify”.
  2. Jika Anda memiliki repo privat, Anda harus mengatur peran sebagaiMaintainer.
  3. Pilihapidanread_apiuntuk cakupannya.

c. Terakhir klikCreate project access tokendan salin tokennya.

3

Atur koneksi

DalamMintlify dashboard, tambahkan ID proyek dan token akses dari langkah-langkah sebelumnya bersama dengan konfigurasi lainnya. Klik “Simpan Perubahan” ketika Anda selesai.

​
Buat webhook

Webhook memungkinkan kami menerima peristiwa ketika perubahan dilakukan sehingga kami dapat secara otomatis memicu deployment.

1

Navigasikan ke Pengaturan > Webhook dan klik 'Tambah Webhook baru'

2

Atur URL dan webhook

Di kolom “URL”, masukkan endpointhttps://leaves.mintlify.com/gitlab-webhookdan beri nama webhook “Mintlify”.

3

Tempel token

Tempel token Webhook yang dihasilkan setelah mengatur koneksi.

4

Pilih peristiwa

Pilih peristiwa yang ingin Anda picu webhook:

  • Peristiwa push (Semua cabang)
  • Peristiwa permintaan penggabungan

Ketika Anda selesai, seharusnya terlihat seperti ini:

5

Uji Webhook

Setelah membuat Webhook, klik dropdown “Uji” dan pilih “Peristiwa push” untuk mengirim payload sampel untuk memastikan konfigurasi sudah benar. Akan mengatakan “Hook dieksekusi dengan sukses: HTTP 200” jika dikonfigurasi dengan benar.

Ini akan membantu Anda memverifikasi bahwa semuanya berfungsi dengan benar dan bahwa dokumentasi Anda akan tersinkronisasi dengan baik dengan repositori GitLab Anda.

Hubungi tim Mintlify jika Anda membutuhkan bantuan. Hubungi kami

here.