Saltar al contenido principal
Usamos tokens de acceso y webhooks para autenticar y sincronizar cambios entre GitLab y Mintlify.
  • Mintlify utiliza tokens de acceso para obtener información de GitLab.
  • GitLab utiliza webhooks para notificar a Mintlify cuando se realizan cambios, lo que habilita implementaciones de vista previa para las solicitudes de merge.

​
Configura la conexión

Se requiere clonación por HTTPS: Tu proyecto de GitLab debe tener habilitada la clonación por HTTPS para que Mintlify pueda acceder a tu repositorio. Puedes verificarlo en GitLab yendo a Settings > General > la sección Visibility and access controls de tu proyecto.
1

Find your project ID

En tu proyecto de GitLab, ve a Settings > General y ubica tu Project ID.
La página General Settings en el dashboard de GitLab. El Project ID está destacado.
2

Generate an access token

Ve a Settings > Access Tokens y selecciona Add new token.Configura el token con estos parámetros:
  • Name: Mintlify
  • Role: Maintainer (obligatorio para repos privados)
  • Scopes: api y read_api
Haz clic en Create project access token y copia el token.
Si los Project Access Tokens no están disponibles, puedes usar un Personal Access Token en su lugar. Ten en cuenta que los Personal Access Tokens caducan y deben actualizarse.
La página Access tokens en el dashboard de GitLab. Los parámetros a configurar para Mintlify están destacados.
3

Set up the connection

En el Dashboard de Mintlify:
  1. Ingresa tu Project ID y el access token.
  2. Completa cualquier otra configuración obligatoria.
  3. Haz clic en Guardar cambios.
La página Git Settings en el Dashboard de Mintlify. La configuración de GitLab está destacada.

​
Crear el webhook

Los webhooks nos permiten recibir eventos cuando se realizan cambios y así activar implementaciones automáticamente.
1

Ve a Settings > Webhooks y haz clic en 'Add new Webhook'

Captura de pantalla de la página de Webhooks en el dashboard de GitLab.
2

Configura la URL y el webhook

En el campo “URL”, ingresa el endpoint https://leaves.mintlify.com/gitlab-webhook y asigna al webhook el nombre “Mintlify”.
3

Pega el token

Pega el token del webhook generado después de configurar la conexión.
Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify. El botón Show Webtoken está resaltado.
4

Selecciona los eventos

Selecciona estos eventos para activar el webhook:
  • Push events (All branches)
  • Merge requests events
Cuando termines, debería verse así:
La página de Webhook en el dashboard de GitLab. Los ajustes para configurar Mintlify están resaltados.
5

Prueba el webhook

Después de crear el webhook, haz clic en el menú desplegable “Test” y selecciona “Push events” para enviar una carga de ejemplo y asegurarte de que esté configurado correctamente. Verás el mensaje “Hook executed successfully: HTTP 200” si todo está bien.Esto te ayudará a verificar que todo funcione correctamente y que tu documentación se sincronice correctamente con tu repositorio de GitLab.
Captura de pantalla de la página de Webhooks de GitLab. El elemento de menú 'Push events' está resaltado en el menú 'Test'.
⌘I