Utilizamos una combinación de tokens de acceso y Webhooks para autenticar y sincronizar cambios entre GitLab y Mintlify.

  • Utilizamos tokens de acceso para obtener información de GitLab.
  • Utilizamos Webhooks para que GitLab pueda notificar a Mintlify cuando se realizan cambios.
    • Esto permite a Mintlify crear despliegues de vista previa cuando se crea una MR.

​
Configurar la conexión

1

Encuentre su ID de proyecto

Dentro de su proyecto de GitLab, navegue aSettings>Generaly encuentre elProject ID.

2

Generar un token de acceso

a. Navegue aSettings>Access Tokens.

b. SeleccioneAdd new token.

  1. Nombre el token “Mintlify”.
  2. Si tiene un repositorio privado, debe establecer el rol comoMaintainer.
  3. Elijaapiyread_apipara los alcances.

c. Finalmente, haga clic enCreate project access tokeny copie el token.

3

Configurar la conexión

Dentro delpanel de control de Mintlify, agregue el ID del proyecto y el token de acceso de los pasos anteriores junto con las otras configuraciones. Haga clic en “Guardar cambios” cuando haya terminado.

​
Crear el webhook

Los webhooks nos permiten recibir eventos cuando se realizan cambios para que podamos activar despliegues automáticamente.

1

Navegue a Configuración > Webhooks y haga clic en 'Agregar nuevo Webhook'

2

Configurar URL y webhook

En el campo “URL”, ingrese el punto finalhttps://leaves.mintlify.com/gitlab-webhooky nombre el webhook “Mintlify”.

3

Pegar token

Pegue el token de Webhook generado después de configurar la conexión.

4

Seleccionar eventos

Seleccione los eventos que desea que activen el webhook:

  • Eventos de push (Todas las ramas)
  • Eventos de solicitudes de fusión

Cuando haya terminado, debería verse así:

5

Probar el Webhook

Después de crear el Webhook, haga clic en el menú desplegable “Probar” y seleccione “Eventos de push” para enviar una carga útil de muestra y asegurarse de que esté configurado correctamente. Dirá “Hook ejecutado con éxito: HTTP 200” si está configurado correctamente.

Esto le ayudará a verificar que todo esté funcionando correctamente y que su documentación se sincronizará adecuadamente con su repositorio de GitLab.

Comuníquese con el equipo de Mintlify si necesita ayuda. Contáctenos

aquí.