Github
O Mintlify se integra com a API do GitHub, permitindo a sincronização entre seus documentos e seu repositório GitHub. Essa integração é possível através da utilização deGitHub Apps.
Instalação
Para começar, você precisa instalar o GitHub App do Mintlify na conta do GitHub onde seu repositório de documentação está localizado. A instalação de um GitHub App requer propriedade da organização ou permissões de administrador em um repositório. Se você não tiver as permissões necessárias, o proprietário do repositório precisará aprovar a solicitação. Você pode acessar a página de instalação fazendo login nopainel do Mintlify.
Para GitHub Apps, você pode optar por dar permissões apenas a um único repositório. Recomendamos fortemente que você faça isso, pois só precisamos de acesso ao repositório onde seus documentos estão hospedados.
Permissões
Quando você instalar o GitHub app, será solicitado a conceder as seguintes permissões:
- Leituraacesso a
metadata - Leituraeescritaacesso a
checks,code,deployments,pull requests, eworkflows
Essas permissões são utilizadas para fornecer uma experiência perfeita ao gerenciar sua documentação.
Quando você faz um commit no branch configurado como seu branch de implantação de documentação, buscamos o conteúdo dos arquivos alterados para atualizar sua documentação. Para realizar isso, precisamos de acesso de leitura ao seucontents.
Quando pull requests são criados, criamos uma verificação e uma implantação de preview, por isso precisamos de acesso de escrita parachecksedeployments.
Dentro do editor web do Mintlify, o Mintlify trabalha em seu nome para criar branches e pull requests, por isso precisamos de acesso de escrita parapull requestse
workflows.
Se você está preocupado com as permissões de escrita, o GitHub App só terá acesso aos repositórios que você conceder acessoese você tiver proteções de branch ativadasnão podefazer push diretamente para seus branches - ele obedece às suas regras de proteção de branch.
Instalações de Repositórios
Ao instalar nosso GitHub app, você será solicitado a selecionar todos os repositórios ou um subconjunto deles. Essa seleção pode ser alterada a qualquer momento indo para as configurações do GitHub app.