Github

Mintlify se integra con la API de GitHub, permitiendo la sincronización entre tus documentos y tu repositorio de GitHub. Esta integración es posible gracias a la utilización deGitHub Apps.

Instalación

Para comenzar, necesitas instalar la GitHub App de Mintlify en la cuenta de GitHub donde reside el repositorio de tus documentos. La instalación de una GitHub App requiere ser propietario de la organización o tener permisos de administrador en un repositorio. Si no tienes los permisos necesarios, el propietario del repositorio deberá aprobar la solicitud. Puedes acceder a la página de instalación iniciando sesión en elMintlify dashboard.

Para las GitHub Apps, puedes elegir dar permisos solo a un único repositorio. Recomendamos encarecidamente que lo hagas así, ya que solo necesitamos acceso al repositorio donde están alojados tus documentos.

Permisos

Cuando instales la GitHub app, se te pedirá que otorgues los siguientes permisos:

• Read acceso ametadata
• Read ywrite acceso achecks,code,deployments,pull requests, yworkflows

Estos permisos se utilizan para proporcionar una experiencia fluida al gestionar su documentación.

Cuando realiza un commit en la rama que configuró como su rama de despliegue de documentación, obtenemos el contenido de los archivos modificados para actualizar su documentación. Para lograr esto, necesitamos acceso de lectura a sucontents.

Cuando se crean pull requests, creamos una verificación y un despliegue de vista previa, por lo que necesitamos acceso de escritura achecksydeployments.

Dentro del editor web de Mintlify, Mintlify trabaja en su nombre para crear ramas y pull requests, por lo que necesitamos acceso de escritura apull requestsy workflows.

Si le preocupan los permisos de escritura, la aplicación de GitHub solo tendrá acceso a los repositorios a los que usted le otorgue accesoysi tiene protecciones de rama activadasno puedehacer push directamente a sus ramas - cumple con sus reglas de protección de ramas.

Instalaciones de Repositorios

Al instalar nuestra aplicación de GitHub, se le pedirá que seleccione todos los repositorios o un subconjunto de ellos. Esta selección se puede cambiar en cualquier momento yendo a la configuración de la aplicación de GitHub.