Clonar e atualizar o conteúdo da wiki offline

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

O processo de atualização do wiki offline é o mesmo que desenvolver código em um repositório Git. Você pode usar suas ferramentas de linha de comando de cliente e git preferenciais para atualizar suas páginas wiki offline. Para obter detalhes sobre como trabalhar com repositórios Git e ferramentas com suporte, consulte a Documentação do Git do Azure Repos.

As etapas básicas para atualizar o conteúdo wiki offline incluem:

1. Clone seu repositório Git wiki para seu IDE (ambiente de desenvolvimento interativo) local ou workspace.

2. Adicione arquivos ou pastas ao branch de repositório Git local.

3. Atualize os arquivos .order para refletir as alterações de sequência para páginas e subpáginas.

4. Confirme e faça o push das atualizações para o branch Git local.

Pré-requisitos

Clone seu wiki

Seu repositório wiki armazena páginas, imagens, anexos e a sequência de páginas e subpáginas. Clone seu wiki para começar.

1. Entre no projeto (https://dev.azure.com/<Organization>/<Project>).

2. Selecione seu wiki e selecione Mais ações (...) >Clone wiki:

   

3. Na caixa de diálogo Clonar repositório, selecione o ícone Copiar URL do clone para a área de transferência:

   

4. Cole a URL no navegador. A página do repositório Git se abre, onde você pode visualizar os arquivos definidos no branch wikiMain. O exemplo a seguir mostra os arquivos no repositório Git para o projeto CanaryBuilds:

   

   Importante

   O recurso Gerar Credenciais do Git está planejado para remoção. Revise a documentação de Autenticação Git para todos os métodos de autenticação disponíveis para operações git clone.

5. Use a URL copiada para clonar o repositório em seu IDE preferido. Para obter mais informações, consulte os seguintes artigos:

   • Clonar um repositório Git existente
   • Usar o Controle de Versão no Visual Studio Code
   • Introdução ao Git e ao Azure DevOps

Adicionar páginas ao repositório Git local

As páginas de repositório Git são formatadas como arquivos Markdown (.md). Para cada página que você deseja adicionar ao wiki, crie um arquivo Markdown em seu branch local. Depois de adicionar páginas, você atualiza o arquivo .order para ajustar a sequência de páginas para incluir as novas páginas.

Adicionar páginas

Você pode adicionar páginas na parte superior da estrutura wiki na pasta raiz (\) e também em outras pastas.

1. Crie o arquivo Markdown (.md) com o conteúdo da nova página. Na maioria dos casos, o nome do arquivo corresponde ao título da página. No nome do arquivo, substitua todos os espaços no título por hifens (-). Para obter mais informações sobre como criar conteúdo de página, consulte Adicionar uma página wiki.

2. Coloque o arquivo na pasta desejada dentro da estrutura wiki em seu branch local, como a pasta raiz. A pasta raiz do exemplo do projeto CanaryBuilds é C:\Users\UserName\Source\Repos\CanaryBuilds.wiki:

   

3. Atualize o arquivo .order na mesma pasta em que você colocou o novo arquivo de página. O texto de entrada da página é o nome do arquivo sem a extensão Markdown (.md). O exemplo do projeto CanaryBuilds adiciona a nova página "Como contribuir", que corresponde ao texto de entrada Como contribuir:

   Welcome
   Roadmap  
   How-to-contribute  
   Home  
   Reference  
   

   Para obter mais informações sobre o arquivo .order , consulte a sequência de páginas e o arquivo .order.

Adicionar subpáginas

Você também pode criar subpáginas para uma página em seu wiki:

1. Crie um diretório para servir como a página principal. Para obter mais informações, consulte arquivos de repositório e estrutura de pastas.

2. Crie o arquivo Markdown para cada subpágina e coloque o arquivo na pasta de página pai. O exemplo do projeto CanaryBuilds adiciona a pasta How-to-contribute como a página pai:

   

3. Crie um arquivo .order na pasta de página pai para definir a sequência para as subpáginas como elas devem ser exibidas no wiki. O exemplo mostra uma possível ordem de subpáginas:

   Request-extensions  
   Licensing  
   Smoke-test  
   Coding-guidelines  
   

Salve suas alterações

Quando as atualizações locais estiverem prontas, envie os arquivos por push para o repositório Git.

As páginas e subpáginas adicionadas aparecem imediatamente em sua wiki. O exemplo a seguir mostra as atualizações do projeto CanaryBuilds:

Se houver erros no processo, a página aparecerá na lista de arquivos wiki com um símbolo de aviso :

Conteúdo relacionado

• Arquivos do repositório Wiki Git e estrutura de arquivos
• Clonar um repositório Git existente
• Diretrizes de sintaxe para arquivos Markdown, widgets, wikis e comentários de solicitação de pull