Utilizziamo token di accesso e webhook per autenticare e sincronizzare le modifiche tra GitLab e Mintlify.
  • Mintlify utilizza token di accesso per recuperare informazioni da GitLab.
  • GitLab utilizza webhook per notificare Mintlify quando vengono apportate modifiche, abilitando i deployment di anteprima per le merge request.

​
Configurare la connessione

1

Trova l'ID del progetto

Nel progetto GitLab, vai su Settings > General e individua il Project ID.
La pagina General Settings nella dashboard di GitLab. Il Project ID è evidenziato.
2

Genera un token di accesso

Vai su Settings > Access Tokens e seleziona Add new token.Configura il token con queste impostazioni:
  • Name: Mintlify
  • Role: Maintainer (obbligatorio per i repository privati)
  • Scopes: api e read_api
Fai clic su Create project access token e copia il token.
Se i Project Access Tokens non sono disponibili, puoi usare un Personal Access Token. Tieni presente che i Personal Access Tokens scadono e devono essere aggiornati.
La pagina Access Tokens nella dashboard di GitLab. Le impostazioni da configurare per Mintlify sono evidenziate.
3

Configura la connessione

Nel dashboard di Mintlify:
  1. Inserisci il Project ID e l’access token.
  2. Completa le altre configurazioni richieste.
  3. Fai clic su Save Changes.
La pagina Git Settings nel dashboard di Mintlify. Le impostazioni di configurazione di GitLab sono evidenziate.

​
Crea il webhook

I webhook consentono di ricevere eventi quando vengono apportate modifiche, così da poter attivare automaticamente i deployment.
1

Vai su Settings > Webhooks e fai clic su 'Add new Webhook'

2

Configura URL e webhook

Nel campo “URL”, inserisci l’endpoint https://leaves.mintlify.com/gitlab-webhook e assegna al webhook il nome “Mintlify”.
3

Incolla il token

Incolla il token del webhook generato dopo aver configurato la connessione.
4

Seleziona gli eventi

Seleziona questi eventi per attivare il webhook:
  • Push events (All branches)
  • Merge requests events
Al termine, dovrebbe apparire così:
La pagina Webhook nella dashboard di GitLab. Le impostazioni da configurare per Mintlify sono evidenziate.
5

Testa il webhook

Dopo aver creato il webhook, apri il menu a tendina “Test” e seleziona “Push events” per inviare un payload di esempio e verificare che la configurazione sia corretta. Se tutto è a posto, vedrai “Hook executed successfully: HTTP 200”.Questo ti aiuterà a verificare che tutto funzioni correttamente e che la documentazione si sincronizzi correttamente con il repository GitLab.