mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
ff9f428146
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
115 lines
5.7 KiB
Plaintext
115 lines
5.7 KiB
Plaintext
---
|
|
title: "GitHub"
|
|
description: "Conecta un repositorio de GitHub para implementaciones automatizadas, vistas previas de solicitudes de extracción y sincronización continua."
|
|
keywords: ["GitHub App", "repository connection", "automated deployments"]
|
|
---
|
|
|
|
Mintlify utiliza una Aplicación de GitHub para sincronizar automáticamente tu documentación con tu repositorio de GitHub.
|
|
|
|
<div id="installing-the-github-app">
|
|
## Instalación de 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).
|
|
|
|
<Tip>
|
|
Recomendamos otorgar acceso solo al repositorio donde se aloja tu documentación.
|
|
</Tip>
|
|
|
|
<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="/images/github/select-repos.png" />
|
|
</Frame>
|
|
|
|
<div id="permissions">
|
|
## Permisos
|
|
</div>
|
|
|
|
Cuando instales la Aplicación de GitHub, se te pedirá que concedas 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="managing-repository-access">
|
|
## Gestión del acceso a repositorios
|
|
</div>
|
|
|
|
Al instalar nuestra Aplicación de GitHub, puedes conceder acceso a todos tus repositorios o solo a algunos específicos. Recomendamos conceder acceso únicamente a los repositorios donde se encuentra tu documentación. 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="configuring-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="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>
|
|
|
|
Si no puedes habilitar las opciones de sugerencias de edición o de creación de issues en tu dashboard y tu repositorio es público, 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="/images/github/revalidate-settings-light.png"
|
|
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"
|
|
/>
|
|
<img
|
|
src="/images/github/revalidate-settings-dark.png"
|
|
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"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
</Steps> |