GitHub

Planos compatíveis com este recurso: Business Enterprise

Com a Document360 integração e GitHub , sua equipe pode vincular perfeitamente os artigos da base de conhecimento aos 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,

Navegue até Configurações () na barra de navegação esquerda no portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Portal da base de conhecimento > Extensões > Colaboração em equipe.
Você pode encontrar a GitHub extensão na Repositórios de código seção.
Clique Ligar no bloco de extensão.
Um novo painel de instalação será aberto.
Selecione 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.
Clique em Instalar.

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

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

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

A categoria de repositório, juntamente com todas as ramificações, é criada como artigos no Document360. Cada vez que um GitHub usuário atualiza o repositório, o conteúdo é sincronizado com os artigos mapeados Document360 .
Você pode identificar cada entidade na Document360 GitHub categoria por um ícone de ramificação ().

Configurando um repositório Git
Para configurar um repositório Git para acesso ao conteúdo no Document360,
Certifique-se de que o repositório Git esteja configurado e configurado adequadamente 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 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:
- 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.

Perguntas Freqüentes

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

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

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

A integração oferece suporte a uma sincronização unidirecional, do GitHub para o Document360. Depois de conectado, a estrutura do repositório GitHub é replicada como está no Document360. Não há suporte para a exportação de conteúdo do Document360 para o GitHub.

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

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

Podemos visualizar ou editar artigos do GitHub no Document360?

Não. Os artigos sincronizados com o GitHub são somente leitura dentro do Document360. Não é possível editar ou visualizar versões não publicadas no Document360. Os artigos sincronizados já estarão publicados e só poderão ser editados no GitHub.

Preciso acionar a sincronização manualmente?

Não. Depois que a conexão do GitHub é configurada, o Document360 efetua pull e publica atualizações automaticamente sempre que as confirmações são enviadas.

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

Não, o histórico de revisões e o controle 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 do 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 com o GitHub.