GitHub

Planos compatíveis com este recurso: Business Enterprise

Com a integração Document360 e GitHub , sua equipe pode conectar de forma fluida os artigos da base de conhecimento aos problemas GitHub , 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 isso sem precisar alternar entre as plataformas.

Configurando o GitHub no Document360

Para configurar o GitHub no Document360,

Navegue até Conexões () > Extensões na barra de navegação à esquerda no portal da Base de Conhecimento.
Você pode encontrar a extensão GitHub na seção Repositórios de código .
Clique Ligar no bloco de extensão.
Um novo painel de Instalação será aberto.
Selecione uma das duas opções de acordo com suas necessidades:
- Todos os repositórios - escolha sincronizar todos os repositórios.
- Selecione apenas repositórios - escolha sincronizar os específicos de acordo com as necessidades do seu projeto.
Clique Instalar.

2_Screenshot-Authorization_page Se você não estiver logado no GitHub, será redirecionado para a tela de login.

Insira suas credenciais GitHub e faça login. Você será redirecionado para o Knowledge base portal Document360. O módulo Criar nova categoria será exibido.
Selecione GitHub () como tipo de categoria. Selecione o repositório do seu GitHub configurado.

Um diálogo de confirmação dizendo 'Seu GitHub foi iniciado com sucesso' aparecerá novamente.

A categoria repositório, junto com todos os branches, é criada como artigos no Document360. Cada vez que um usuário GitHub atualiza o repositório, o conteúdo é sincronizado com os artigos Document360 .
Você pode identificar cada entidade no Document360 na categoria GitHub por um ícone de branch ().

Configurando um repositório Git
Para configurar um repositório Git para acesso ao conteúdo no Document360,
Certifique-se de que seu repositório Git esteja devidamente configurado e configurado para permitir a busca do conteúdo para o projeto 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.
- O nome dessa 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.
- O nome dessa pasta deve permanecer inalterado.
  Por exemplo, se uma imagem for referenciada em um arquivo chamado 'O que é Document360', ela deve 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:
- Faça o upload do arquivo de mídia para a .document360/assets pasta.
- Use a seguinte sintaxe para inserir o arquivo de mídia no seu artigo:
```
![image description](/docs/.document360/assets/mediafilename.extension)
```
- Por exemplo, se seu arquivo de mídia tem um nome test.png, use:
```
![test image](/docs/.document360/assets/test.png)
```

Perguntas Freqüentes

As contas da equipe podem editar ou publicar os artigos criados na categoria do GitHub?

Contas de equipe não podem editar ou publicar os artigos criados na categoria do GitHub. Se alguma alteração precisar ser feita, edite o repositório fonte no GitHub e as alterações serão sincronizadas com o artigo Document360 .

Como funciona a importação e exportação?

A integração suporta uma sincronização unidirecional, do GitHub para o Document360. Uma vez conectado, a estrutura do seu repositório do GitHub é replicada como está no Document360. Exportar conteúdo de volta do Document360 para o GitHub não é suportado.

Quando enviamos um commit no GitHub, isso automaticamente envia uma build no Document360?

Sim. Quando você faz commit de alterações no seu branch vinculado do GitHub, as atualizações são automaticamente sincronizadas e publicadas no Document360.

Podemos pré-visualizar ou editar artigos do GitHub no Document360?

Não. Artigos sincronizados no GitHub são somente leitura dentro do Document360. Você não pode editar ou pré-visualizar versões não publicadas dentro do Document360. Os artigos sincronizados já serão publicados e só poderão ser editados no GitHub.

Preciso acionar a sincronização manualmente?

Não. Uma vez configurada a conexão do GitHub, o Document360 automaticamente puxa e publica atualizações sempre que os commits são enviados.

Existem rascunhos ou histórico de revisões para artigos sincronizados?

Não, histórico de revisões e acompanhamento de alterações não estão disponíveis para artigos sincronizados com o GitHub no Document360.

Posso criar novas páginas no Document360 para projetos no GitHub?

Você só pode criar novas páginas no GitHub. A estrutura de pastas e artigos no GitHub é espelhada exatamente no Document360. A criação de novos artigos não é permitida no Document360 para categorias sincronizadas no GitHub.