> ## Documentation Index
> Fetch the complete documentation index at: https://adminroletesting-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Conecta tu repositorio de GitHub a Mintlify para despliegues automatizados, vistas previas de pull requests y sincronización continua de la documentación.

Mintlify utiliza una Aplicación de GitHub para sincronizar automáticamente tu documentación con tu repositorio de GitHub.

<Tip>
  **¿Necesitas la Aplicación de GitHub?**

  * **Repositorio alojado en Mintlify** en la organización `mintlify-community`: No. La Aplicación de GitHub ya está configurada.
  * **Tu propio repositorio**: Sí. Instala la Aplicación de GitHub para habilitar implementaciones automáticas cuando envíes cambios.

  Consulta tu repositorio en la página [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) de tu dashboard.
</Tip>

Si tu repositorio es privado y pertenece a la organización Mintlify, la Aplicación de GitHub está configurada y gestionada automáticamente por Mintlify. Puedes usar el editor web para realizar cambios en tu documentación. Si quieres trabajar en tu documentación de forma local, clona el repositorio en tu propia organización y actualiza tu configuración de Git para usar tu propio repositorio.

<div id="clone-to-your-own-repository">
  ## Clonar en tu propio repositorio
</div>

Si omitiste conectar tu propio repositorio de Git durante la configuración inicial, tu documentación se encuentra en un repositorio privado propiedad de la organización de Mintlify. Para moverla a tu propia cuenta u organización, ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) en tu dashboard. Un asistente de configuración te guía a través del proceso con dos opciones:

<AccordionGroup>
  <Accordion title="Clonar con un clic (recomendado)">
    La opción de clonación crea automáticamente una copia de tu documentación en tu cuenta de GitHub.

    1. Selecciona **GitHub** como tu proveedor.
    2. Haz clic en **Clone**.
    3. Autoriza con GitHub cuando se te solicite.
    4. Selecciona la organización de GitHub donde deseas crear el repositorio.
    5. Confirma la clonación. Mintlify copia tus archivos de documentación en un nuevo repositorio.
    6. Opcionalmente, instala la Aplicación de GitHub de Mintlify para despliegues automáticos.
  </Accordion>

  <Accordion title="Configuración manual">
    <Warning>
      Este proceso elimina permanentemente tu contenido del repositorio alojado en Mintlify.

      Descarga tu documentación desde el asistente de configuración antes de completar el proceso de configuración manual.
    </Warning>

    Si prefieres configurar tu repositorio manualmente:

    1. Descarga tu documentación como un archivo zip para tener una copia de seguridad de tus archivos.
    2. Selecciona **GitHub** como tu proveedor.
    3. Haz clic en **Continue setup**.
    4. Autoriza con GitHub cuando se te solicite.
    5. Selecciona tu organización, repositorio y rama.
    6. Opcionalmente, especifica un subdirectorio si tu documentación no está en la raíz del repositorio.
    7. Guarda tu configuración.
  </Accordion>
</AccordionGroup>

Después de completar cualquiera de las opciones, instala la Aplicación de GitHub siguiendo los pasos en [Instalar la Aplicación de GitHub](#install-the-github-app).

<div id="install-the-github-app">
  ## Instalar la Aplicación de GitHub
</div>

<Note>
  Debes ser propietario de la organización o tener permisos de administrador en un repositorio para instalar la aplicación. Si no cuentas con los permisos necesarios, el propietario del repositorio debe aprobar la solicitud de instalación.
</Note>

Instala la Aplicación de GitHub de Mintlify desde tu [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

<Frame>
  <img className="h-80" alt="Página de instalación de la Aplicación de GitHub de Mintlify con la opción «Only select repositories» seleccionada." src="https://mintcdn.com/adminroletesting-justin-client-exports/PdUMLzGWBM_RlEqQ/images/github/select-repos.png?fit=max&auto=format&n=PdUMLzGWBM_RlEqQ&q=85&s=151a93723a49dba33445b8c2f26dcb57" width="2980" height="1702" data-path="images/github/select-repos.png" />
</Frame>

<div id="permissions">
  ## Permisos
</div>

Cuando instales la Aplicación de GitHub, concede los siguientes permisos.

Permisos de lectura:

* `metadata`: Información básica del repositorio

Permisos de lectura y escritura:

* `checks`: Crear verificaciones de estado en solicitudes de extracción
* `code`: Leer cambios en archivos cuando haces una confirmación en tu branch de documentación
* `deployments`: Generar implementaciones de vista previa para solicitudes de extracción
* `pull requests`: Crear branches y solicitudes de extracción desde el editor web

<Info>
  La aplicación solo accede a los repositorios a los que le otorgues acceso explícitamente. Si tienes reglas de protección de branches habilitadas, la aplicación no puede hacer push directamente a branches protegidos.
</Info>

<div id="manage-repository-access">
  ## Gestión del acceso a repositorios
</div>

Al instalar la Aplicación de GitHub, puedes conceder acceso a todos tus repositorios o solo a algunos específicos. Recomendamos conceder acceso únicamente a tu repositorio de documentación y a cualquier otro repositorio que quieras proporcionar como contexto para el agente o los workflows. Puedes modificar esta selección en cualquier momento en la [configuración de la Aplicación de GitHub](https://github.com/apps/mintlify/installations/new).

<div id="configure-docs-source">
  ## Configurar la fuente de la documentación
</div>

Cambia la organización, el repositorio o la branch desde la que se compila tu documentación en la sección [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) de tu dashboard.

<div id="github-enterprise-with-ip-allowlists">
  ## GitHub Enterprise con listas de IP permitidas
</div>

Si tu organización de GitHub Enterprise Cloud tiene habilitada una lista de IP permitidas, debes agregar la dirección IP saliente de Mintlify (`54.242.90.151`) a tu lista para que la Aplicación de GitHub funcione correctamente.

Sigue la [documentación de GitHub](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) para configurar tu lista de IP permitidas.

<div id="troubleshooting">
  ## Resolución de problemas
</div>

<div id="deployment-not-triggering-automatically">
  ### La implementación no se activa automáticamente
</div>

Si los pushes a tu repositorio no desencadenan implementaciones, revisa los siguientes posibles problemas.

<AccordionGroup>
  <Accordion title="Verificar la instalación de la Aplicación de GitHub">
    Comprueba que la aplicación esté instalada en el repositorio correcto.

    1. Ve a la [configuración de la Aplicación de GitHub](https://dashboard.mintlify.com/settings/organization/github-app) en tu dashboard.
    2. Verifica que tu repositorio esté en la lista de instalaciones activas de la aplicación.
  </Accordion>

  <Accordion title="Comprobar la rama de implementación">
    Asegúrate de que estás haciendo push a la rama correcta.

    1. Ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings)
    2. Verifica que la rama en tu dashboard coincida con la rama a la que estás haciendo push.
  </Accordion>
</AccordionGroup>

<div id="github-app-connection-issues">
  ### Problemas de conexión con la Aplicación de GitHub
</div>

Si tienes problemas con la Aplicación de GitHub, restablecer la conexión puede resolver la mayoría de los casos.

<Steps>
  <Step title="Desinstala la aplicación de Mintlify desde GitHub.">
    1. En GitHub, ve a [installations](https://github.com/settings/installations) y selecciona **Configure** junto a la aplicación de Mintlify. Desplázate hacia abajo y selecciona **Uninstall**.
    2. Ve a [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) y selecciona **Revoke** junto a la aplicación de Mintlify.
  </Step>

  <Step title="Reinstala la aplicación de Mintlify.">
    1. En tu Dashboard de Mintlify, ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) e instala la Aplicación de GitHub.
    2. Autoriza tu cuenta en la sección [My Profile](https://dashboard.mintlify.com/settings/account) de tu dashboard.
  </Step>
</Steps>

<div id="feedback-add-ons-are-unavailable">
  ### Los complementos de comentarios no están disponibles
</div>

Las funciones de comentarios de sugerencias de edición y de creación de issues solo están disponibles para repositorios públicos de GitHub. Si estas opciones están deshabilitadas en tu dashboard, verifica la visibilidad de tu repositorio.

Si tu repositorio es público y no puedes habilitar las opciones de sugerencias de edición o de creación de issues en tu dashboard, vuelve a validar tu configuración de Git.

<Steps>
  <Step title="Ir a Git Settings">
    Ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) en tu dashboard.
  </Step>

  <Step title="Volver a validar la configuración">
    Haz clic en la marca de verificación verde en la esquina del recuadro de configuración de Git para volver a validar la configuración de tu repositorio. Esto forzará la actualización de la configuración para reflejar si tu repositorio es público o privado.

    <Frame>
      <img src="https://mintcdn.com/adminroletesting-justin-client-exports/PdUMLzGWBM_RlEqQ/images/github/revalidate-settings-light.png?fit=max&auto=format&n=PdUMLzGWBM_RlEqQ&q=85&s=0203f6deb7b867c277cf3e0b8f08326a" alt="La página de Git Settings en el Dashboard de Mintlify. Una flecha naranja apunta a la marca de verificación verde que vuelve a validar la configuración del repositorio." className="block dark:hidden" width="1996" height="1168" data-path="images/github/revalidate-settings-light.png" />

      <img src="https://mintcdn.com/adminroletesting-justin-client-exports/PdUMLzGWBM_RlEqQ/images/github/revalidate-settings-dark.png?fit=max&auto=format&n=PdUMLzGWBM_RlEqQ&q=85&s=1d06ea0523e451dc9ee9a02e8e9fe69b" alt="La página de Git Settings en el Dashboard de Mintlify. Una flecha naranja apunta a la marca de verificación verde que vuelve a validar la configuración del repositorio." className="hidden dark:block" width="1998" height="1170" data-path="images/github/revalidate-settings-dark.png" />
    </Frame>
  </Step>
</Steps>