Saltar al contenido principal
Mintlify usa tokens de acceso y webhooks para autenticar y sincronizar cambios entre GitLab y Mintlify.
  • Mintlify usa tokens de acceso para extraer información de GitLab.
  • GitLab usa webhooks para notificar a Mintlify cuando realizas cambios, lo que habilita implementaciones de vista previa para las merge requests.

​
Configura la conexión

Cuando abras Git Settings por primera vez, un asistente de configuración te guía a través de la conexión de tu repositorio de GitLab.
1

Select GitLab as your provider

En la página de Git Settings, selecciona Connect to GitLab y haz clic en Continue.
2

Download your content

Si ya tienes un repositorio de GitLab con tu documentación, puedes omitir la descarga y hacer clic en Continue setup directamente.
Si tu documentación está alojada en Mintlify, descárgala como un archivo zip.
  • Crea un nuevo repositorio en GitLab.
  • Extrae el contenido del zip.
  • Sube el contenido a tu repositorio.
Haz clic en Continue setup para continuar.
3

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.
4

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.
5

Connect your repository

De vuelta en el asistente de configuración, completa los siguientes campos:
  • GitLab instance URL: Déjalo en blanco para gitlab.com, o ingresa la URL de tu instancia autoalojada (por ejemplo, https://gitlab.your-domain.com). Tu instancia debe ser accesible públicamente para que Mintlify pueda conectarse.
  • Project ID: El ID del proyecto de la configuración de tu proyecto de GitLab.
  • GitLab deployment token: El token de acceso que generaste.
  • Branch: Selecciona la rama desde la cual desplegar tu documentación.
Haz clic en Connect.
El panel de configuración de GitLab en la página Git Settings del Dashboard de Mintlify.

​
Actualizar una conexión existente

Para modificar la configuración de tu conexión con GitLab después de la configuración inicial, ve a Git Settings y actualiza tu ID de proyecto, token de acceso, rama o URL de instancia directamente.

​
Volver a validar la configuración de Git

Si tu despliegue muestra un comportamiento inesperado, como opciones de rama faltantes o una configuración desactualizada, puedes forzar a Mintlify a actualizar tu origen de Git.
1

Ir a Git Settings

Ve a Git Settings en tu Dashboard.
2

Volver a validar la configuración

Haz clic en la insignia verde Active en la esquina del recuadro de configuración de GitLab para volver a validar tu origen de Git. Un toast de éxito confirma cuando se completa la revalidación, y aparece un toast de error si tu configuración necesita revisión.

​
Crear el webhook

Los webhooks notifican a Mintlify cuando envías cambios, para que las implementaciones se activen automáticamente.
1

Agregar nuevo webhook

  1. En GitLab, ve a Settings > Webhooks.
  2. Haz clic en Add new webhook.
Captura de pantalla de la página de Webhooks en el dashboard de GitLab.
2

Configurar la URL y el webhook

Asigna al webhook el nombre Mintlify.En el campo URL, introduce el endpoint https://leaves.mintlify.com/gitlab-webhook.
3

Obtener el webtoken

En tu Dashboard de Mintlify, haz clic en Show Webtoken. Copia el webtoken.
Captura de pantalla de la conexión de GitLab en el Dashboard de Mintlify.
4

Pegar el webtoken

En GitLab, pega el webtoken desde tu Dashboard de Mintlify en el campo Secret token.
5

Seleccionar eventos

Selecciona los siguientes eventos para activar el webhook:
  • Push events (All branches)
  • Merge requests events
6

Verificar el webhook

Deberías ver la siguiente configuración después de configurar el webhook:
  • Name: Mintlify
  • URL: https://leaves.mintlify.com/gitlab-webhook
  • Secret token: el webtoken de tu Dashboard de Mintlify
  • Events: Push events (All branches) y Merge requests events
Añade el webhook.
La página de Webhooks en el dashboard de GitLab. La configuración que se debe establecer para Mintlify está resaltada.
7

Probar el webhook

Después de crear el webhook, haz clic en el menú desplegable Test. Haz clic en Push events para enviar un payload de prueba. Si la prueba devuelve Hook executed successfully: HTTP 200, configuraste el webhook correctamente.
Captura de pantalla de la página de Webhooks de GitLab. El elemento de menú 'Push events' está resaltado en el menú 'Test'.