GitHub

Planos que dão suporte à integração de extensões de GitHub com o Document360

Com a integração Document360 e GitHub , sua equipe pode vincular perfeitamente os artigos da base de conhecimento a GitHub problemas, permitindo uma melhor colaboração entre desenvolvedores e redatores técnicos. Você pode acompanhar atualizações, associar tarefas de documentação a alterações de código e garantir que sua base de conhecimento permaneça sincronizada com seu processo de desenvolvimento, tudo sem alternar entre as plataformas.

Configuração do GitHub no Document360

Para configurar o GitHub no Document360,

1. Navegue até Configurações () > Portal da base de conhecimento> Extensões no portal da base de conhecimento.

   Você pode encontrar a extensão GitHub na seção Code repositories .

2. Clique em Ligar no bloco de extensão.

   

   Uma nova janela de instalação será aberta.

3. Selecione qualquer uma das duas opções com base em seus requisitos:

   • Todos os repositórios - escolha sincronizar todos os repositórios.

   • Selecione apenas repositórios - opte por sincronizar repositórios específicos com base nos requisitos do seu projeto.

4. Clique Instalar.

   

   Se você não estiver conectado ao GitHub, será redirecionado para a tela de login.

   5. Insira suas credenciais GitHube faça login.

   Você será redirecionado para o Document360 Knowledge base portal. O módulo Criar nova categoria aparecerá.

   6. Selecione GitHub () como o tipo de categoria.

   7. Selecione o repositório no GitHubconfigurado.
   

   1. Um pop-up de confirmação dizendo 'Seu GitHub foi iniciado com sucesso' aparecerá.

      A categoria de repositório, juntamente com todas as ramificações, são criadas como artigos em Document360. Cada vez que um usuário GitHub atualiza o repositório, o conteúdo é sincronizado com os artigos Document360 mapeados.

   2. Você pode identificar cada entidade em Document360 na categoria GitHub por um ícone de ramificação ().

       

   ---

   Configurando o repositório Git

   Para configurar um repositório Git para acesso ao conteúdo no Document360,

   1. Certifique-se de que o repositório Git esteja configurado corretamente para permitir a busca do conteúdo no projeto do Document360. Siga a estrutura abaixo:

          Pasta principal:

   • No GitHub, o repositório deve incluir uma pasta principal chamada docs onde você pode organizar subpastas e artigos Markdown.

   • Esse nome de pasta deve permanecer inalterado.

     
     Armazenamento de arquivos de mídia:

   • Armazene todos os arquivos de mídia dentro da .document360/assets pasta dentro do docs diretório.

   • Esse nome de pasta deve permanecer inalterado.

     Por exemplo, se uma imagem for referenciada em um arquivo chamado 'O que é Document360', ela deverá ser movida para a .document360/assets pasta.

     
     Armazenamento de artigos:

   • Dentro da docs pasta, crie um diretório separado, por exemplo, articles para armazenar seus artigos.

   • Os artigos devem estar no formato Markdown (.md).

     Inserindo arquivos de mídia em artigos:

   • Carregue o arquivo de mídia para a .document360/assets pasta.

   • Use a seguinte sintaxe para inserir o arquivo de mídia em seu artigo:

     ![image description](/docs/.document360/assets/mediafilename.extension)

   • Por exemplo, se o arquivo de mídia for chamado test.png, use:

     ![test image](/docs/.document360/assets/test.png)

Configuração de integração do GitHub com o Document360

Abaixo está um guia em vídeo passo a passo sobre como configurar e integrar perfeitamente o GitHub ao Document360.