Compartilhar via


Wiki provisionado vs. publicado como wiki de código

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

Você pode manter o conteúdo do wiki em um wiki de projeto de equipe ou em um wiki publicado como código. Com um wiki publicado como código, você pode manter vários wikis versionados para dar suporte às suas necessidades de conteúdo. Essa opção estará disponível quando você habilitar o Azure Repos.

Embora ambas as opções mantenham o conteúdo wiki em repositórios Git, a maneira como você adiciona, atualiza e gerencia o conteúdo wiki é diferente.

Manter o conteúdo wiki

Para ambos os tipos de wiki, você pode trabalhar diretamente no GitHub ou trabalhar offline e, em seguida, enviar suas alterações por push para o repositório.

Para um wiki provisionado, você adiciona e mantém páginas wiki diretamente na seção Páginas Wiki> do repositório. Todas as atualizações de conteúdo para um wiki provisionado ocorrem dentro do próprio wiki.

Para um wiki publicado como código, você adiciona e mantém o conteúdo wiki como arquivos de código no repositório. Você acessa os arquivos nas seções Repos ou Code do repositório no GitHub.

A imagem a seguir mostra as opções de menu para um wiki provisionado:

Captura de tela das opções de menu disponíveis para um wiki provisionado na seção páginas wiki.

Algumas opções de menu não são suportadas para páginas publicadas como wiki de código. Para um wiki publicado como código, a opção Editar no Repos abre a página atual, para que você possa editar o conteúdo no local. Atualizações que você faz em uma página no branch selecionado do wiki são publicadas automaticamente no wiki.

Adicionar páginas wiki

As opções de menu Nova página e Adicionar subpágina estão disponíveis para ambos os tipos de wiki no GitHub. Para obter mais informações, consulte Adicionar e editar páginas wiki.

Ajustar a sequência de páginas e a lista de páginas

Ambos os tipos de wiki aplicam a mesma pasta e estrutura de arquivos no repositório Git. A diferença está em como você mantém a sequência de páginas.

Para um wiki provisionado, o GitHub gerencia a sequência de páginas e a lista de páginas automaticamente à medida que você adiciona ou move páginas dentro do painel de navegação.

Para um wiki publicado como código, você precisa manter a sequência de páginas manualmente. Para estruturar a lista de páginas no painel de navegação, defina um arquivo .order na raiz e para cada subpasta ou página pai que contém subpáginas. Para obter mais informações, consulte arquivos de repositório Git wiki e estrutura de arquivos.

Exibir revisões de página e reverter para a versão anterior

Na página Wiki do repositório Git, você pode exibir as revisões de qualquer página dentro do wiki. Utilize as opções do menu Revisões ou Exibir revisões. Para reverter o conteúdo da página atual para uma versão anterior, o processo é diferente dependendo do tipo de página wiki.

Para uma página wiki provisionada, selecione a opção de menu Reverter. Para mais informações, consulte Reverter um commit para uma página wiki provisionada.

Para uma página wiki publicada como código, você trabalha a partir de uma ramificação local e envia um pull request para atualizar o branch do qual está trabalhando.

Usar o controle de versão e cancelar a publicação do wiki

O suporte ao controle de versão permite que você publique diferentes versões de conteúdo em wikis distintos, com base em uma ramificação versionada de um repositório Git.

Você só poderá criar versões e despublicar um wiki se for o usuário que publicou o código para criar o wiki. Para obter mais informações, consulte Cancelar a publicação de um wiki de código.

Excluir wiki do projeto

As etapas a seguir descrevem como excluir um wiki do projeto.

Observação

Você não pode usar a API REST para excluir um wiki do projeto. Em vez disso, exclua o repositório wiki diretamente.

  1. Clone o repositório wiki para fazer backup de todo o conteúdo. Você pode encontrar a URL wiki no menu Mais opções (...).

  2. Obtenha a ID do repositório Git associada ao wiki. Você pode usar a API REST para obter todas as wikis do projeto.

    Por exemplo, o GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1 comando retorna todos os wikis no projeto. Execute o comando e escolha o wiki a ser excluído.

  3. Exclua o repositório Git associado ao wiki usando a API REST. Use o ID do repositório do wiki do projeto que você encontrou anteriormente. Verifique duas vezes a ID do repositório para garantir que você não remova o wiki errado.

    Por exemplo, o DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/<repositoryId>?api-version=4.1 comando exclui o wiki. Substitua <repositoryId> pelo ID do repositório do wiki a ser excluído.

Atualizar wiki enquanto estiver offline

Você pode trabalhar offline ou em um ramo local para atualizar o conteúdo de ambos os tipos de wiki. Para obter mais informações, consulte Clonar e atualizar páginas wiki offline.

Explorar outros recursos e operações

Ambos os tipos de wiki dão suporte a vários outros recursos e operações:

Algumas operações e recursos estão disponíveis para apenas um tipo de wiki ou a abordagem de uso difere: