Partilhar via


Clone e atualize o conteúdo wiki offline

Serviços de DevOps do Azure | Azure DevOps Server | Azure DevOps Server 2022

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

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

  1. Clona o teu repositório Git wiki para o teu ambiente de desenvolvimento interativo local (IDE) ou para o teu espaço de trabalho.

  2. Adicione arquivos ou pastas à sua ramificação local do repositório Git.

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

  4. Confirme e envie as atualizações para sua filial local do Git.

Pré-requisitos

Categoria Requerimentos
Acesso ao projeto Membro do projeto onde as wikis se localizaram. Você pode solicitar acesso ao seu Administrador do Projeto, conforme necessário.
Permissões - Membro do grupo de Contribuidores.
- Para publicar código como wiki, necessita da permissão de Criar Repositório. Por padrão, essa permissão é definida para membros do grupo Administradores de Projeto.
Níveis de acesso Pelo menos acesso básico.
Tarefas - Entenda a estrutura subjacente do seu repositório Git wiki.
- Entender as diferenças entre um wiki provisionado e um código publicado como wiki.

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. Faça login no seu projeto (https://dev.azure.com/<Organization>/<Project>).

  2. Selecione o seu wiki e, em seguida, selecione Mais ações (...) >Wiki do clone:

    Captura de tela que mostra como selecionar a ação Mais opções Clone wiki Git para o wiki selecionado.

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

    Captura de ecrã mostrando o repositório wiki a ser clonado na caixa de diálogo de clonagem de repositório.

  4. Cole o URL no navegador. A página do repositório Git é aberta, onde você pode visualizar os arquivos definidos na ramificação wikiMain. O exemplo a seguir mostra os arquivos no repositório Git para o projeto CanaryBuilds:

    Captura de tela que mostra a página do repositório Git com os arquivos definidos na ramificação wikiMain.

    Importante

    O recurso Gerar credenciais do Git está planejado para remoção. Consulte a documentação de autenticação do Git para todos os métodos de autenticação disponíveis nas operações de clonagem com Git.

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

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 seu wiki, você cria um arquivo Markdown em sua ramificação local. Depois de adicionar páginas, atualize 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 quaisquer espaços no título por hífenes (-). 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 sua ramificação local, como a pasta raiz. A pasta raiz de exemplo do projeto CanaryBuilds é C:\Users\UserName\Source\Repos\CanaryBuilds.wiki:

    Captura de tela que mostra a ramificação local do repositório Git wiki para o projeto CanaryBuilds.

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

    Welcome
    Roadmap  
    How-to-contribute  
    Home  
    Reference  
    

    Para obter mais informações sobre o arquivo .order , consulte 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 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 da página pai. O exemplo de projeto CanaryBuilds adiciona a pasta How-to-contribute como a página pai:

    Captura de tela que mostra a pasta How-to-contribute no projeto CanaryBuilds com novas subpáginas.

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

    Request-extensions  
    Licensing  
    Smoke-test  
    Coding-guidelines  
    

Empurre as suas alterações

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

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

Captura de tela que mostra a estrutura wiki atualizada para o projeto CanaryBuilds.

Se houver algum erro no processo, a página aparecerá na sua lista de arquivos wiki com um símbolo de Aviso :

Captura de ecrã que mostra uma página com um erro, conforme indicado pelo símbolo de Aviso.