A integração do GitHub permite desenvolver e manter temas colaborativamente no GitHub, para visualização e publicação posteriores no administrador do Conhecimento. Para configurar a integração, verifique se o tema está armazenado no GitHub, depois integre no administrador do Conhecimento.

Qual é o meu plano?
Suite, todas as versões Growth, Professional, Enterprise ou Enterprise Plus
Support com Conhecimento Professional ou Enterprise

Resumo: ◀▼

Você pode conectar um tema da central de ajuda no GitHub ao administrador do Conhecimento, depois visualizar ou publicar atualizações a partir dali. A configuração exige que o repositório de temas tenha um tema e um arquivo manifest.json na raiz. Essa integração possibilita o gerenciamento colaborativo do tema, testes baseados em ramificação, e o GitHub Enterprise Cloud, mas não o GitHub Enterprise Server.

Caminho: Administrador do Conhecimento > Painel de personalização () > Adicionar tema > Adicionar do GitHub

A integração do GitHub permite desenvolver e manter temas colaborativamente no GitHub, para visualização e publicação posteriores no administrador do Conhecimento. Para configurar a integração, verifique se o tema está armazenado no GitHub, depois integre no administrador do Conhecimento.

Observação: a integração do GitHub com a Central de ajuda não oferece suporte ao GitHub Enterprise Server, apenas à GitHub Enterprise Cloud. Se você usa o GitHub Enterprise Server, também pode usar a API de temas do Guide.

Você deve ser um administrador do Conhecimento para definir a integração do GitHub.

Este artigo abrange os seguintes tópicos:
  • Preparação do seu tema no GitHub
  • Configuração da integração

Preparação do seu tema no GitHub

Verifique se o tema está no GitHub antes de configurar a integração no administrador do Conhecimento. Se você não está familiarizado com Git e GitHub, confira este tutorial. Se seu tema já está no GitHub e atende aos requisitos a seguir, consulte Configuração da integração.

A integração tem os seguintes requisitos para o repositório do GitHub:

  • O arquivo de manifesto deve estar na raiz do repositório do GitHub

    O arquivo manifest.json deve ser colocado na raiz do repositório do GitHub para que seja possível adicionar o seu tema. Você ainda pode incluir outros arquivos, como ferramentas, pois eles são ignorados na importação para o administrador do Conhecimento.

  • O repositório do GitHub pode conter apenas um tema

    Você deve gerenciar apenas um tema em cada repositório. Você pode usar a opção de ramificação durante a importação do tema para experimentar variações do tema.

Como colocar seu tema em um repositório do GitHub

  • Se você não tiver um tema no momento, clone o repositório do tema Copenhagen e comece a criar do seu tema. Isso permite que você faça a portabilidade fácil de melhorias do tema Copenhagen para seu tema no futuro.
  • Se o seu tema estiver no administrador do Conhecimento, baixe o tema, crie um repositório do GitHub (se ainda não tiver um) e coloque o tema nele.
  • Se o seu tema não estiver no administrador do Conhecimento nem no GitHub, crie um repositório do GitHub (se ainda não tiver um) e coloque o tema nele.

Após preparar seu tema no GitHub, você já pode configurar a interação.

Configuração da integração

Para configurar a integração no GitHub, você precisa certificar-se de que seu tema está armazenado no GitHub e que ele pode ser colocado no administrador do Conhecimento. Essa obtenção única estabelece uma conexão entre o tema o e o GitHub.

Após configurar a integração, você trabalhará no tema GitHub e atualizará no administrador do Conhecimento quando estiver pronto. No administrador do Conhecimento, você pode visualizar e publicar o tema em uso.

Como configurar a integração do GitHub com seu tema da central de ajuda

  1. No GitHub, certifique-se de que seu tema está pronto.
  2. No Administrador do Conhecimento, clique em Painel de personalização () na barra lateral.

    A página Temas será exibida.

  3. Clique em Adicionar tema no canto superior direito.
  4. Clique em Adicionar do GitHub.

  5. Insira a URL do repositório e, opcionalmente, insira o nome da ramificação (se não for a padrão) e clique em Importar.
  6. Faça login no GitHub se solicitado e siga as instruções para instalar o aplicativo importador de temas do Zendesk do GitHub.

    Selecione a conta ou a organização do GitHub onde o repositório está localizado, depois selecione aqueles que o aplicativo pode acessar. Se você for administrador da organização ou do repositório que está conectando, pode instalar o aplicativo de imediato. Se não tiver as permissões necessárias, o GitHub enviará uma solicitação de instalação ao administrador da organização. A integração pode continuar depois que o administrador instalar o aplicativo e conceder acesso ao repositório.

Ao fim da exportação, a miniatura do tema é exibida na página Temas. Em caso de problemas, consulte Resolução de problemas da integração do GitHub com temas do Guide.

Ao estabelecer a conexão, você gerenciará seu tema no GitHub e o atualizará no administrador do Conhecimento conforme for necessário.

Powered by Zendesk