Wiki provisionado vs. publicado como wiki de código

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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 com controle de versão para dar suporte às suas necessidades de conteúdo, embora ele esteja disponível somente se Azure Repos estiver habilitado.

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.

Observação

O recurso wiki publicado como código está disponível atualmente em Azure DevOps Server 2018 e versões posteriores. Para versões mais antigas, você só pode provisionar um wiki para seu projeto de equipe.

Opções do menu da página wiki

Com um wiki provisionado, você pode adicionar e editar páginas diretamente no wiki. Todas as atualizações de conteúdo para um wiki provisionado ocorrem dentro do wiki.

Com um wiki publicado como código, você pode adicionar, editar e atualizar conteúdo de Repos ou Code.

A imagem a seguir mostra opções para um wiki provisionado. Várias dessas opções não têm suporte para as páginas wiki publicadas como código.

Captura de tela das opções do menu da página wiki provisionada.

Por exemplo, a opção Editar em Repositórios para o wiki publicado como código leva você à página Repositório para editar essa página específica. As atualizações feitas em uma página no branch selecionado para o wiki são publicadas automaticamente no wiki.

Recursos suportados e diferenças operacionais

Ambos os tipos de wiki suportam os seguintes recursos:

A tabela a seguir resume as operações ou recursos que podem ser diferentes, dependendo do tipo de wiki.

Adicionar páginas

Para ambos os tipos de wiki, selecione Nova página ou Adicionar subpágina. Para obter mais informações, consulte Adicionar e editar páginas wiki.

Sequência de páginas e lista de páginas no painel de navegação

O wiki provisionado gerencia a sequência de páginas e a lista de páginas automaticamente à medida que você adiciona ou move páginas no painel de navegação.

Para estruturar a lista de páginas no painel de navegação de um wiki publicado como código, defina o *.order* arquivo na raiz e para cada subpasta ou página pai que contenha subpáginas.

Ambos os tipos de wikis seguem a mesma estrutura de arquivos, só que o wiki publicado como código exige que você mantenha a sequência de páginas manualmente.

Para obter mais informações sobre como trabalhar com .order arquivos, consulte Arquivos do repositório Wiki Git e estrutura de arquivos.

Revisões de página e reversão para uma versão anterior

No wiki, você pode visualizar as revisões de qualquer página wiki. Selecione Revisões ou a opção de menu Exibir revisões .

Mas, o processo de reversão difere dependendo do tipo de página wiki.

  • Para uma página wiki provisionada, selecione Reverter, conforme descrito em Reverter uma confirmação para uma página wiki provisionada
  • Para uma página wiki publicada como código, trabalhe em um branch local e envie uma solicitação de pull para atualizar o branch do qual você está trabalhando.

Controle de versão e cancelamento da publicação de um wiki

Com o controle de versão, você pode publicar diferentes versões de conteúdo em wikis distintos, com base em uma ramificação com controle de versão de um repositório Git. Você pode controlar a versão e cancelar a publicação de um wiki somente se for você quem o criou publicando código em um wiki. Para obter mais informações, consulte Cancelar a publicação de um wiki de código.

Excluir um wiki do projeto

Observação

As APIs REST do wiki não dão suporte à exclusão de um wiki do projeto. Então, você deve excluir o repositório wiki.

  1. Clone o repositório wiki para fazer backup de todo o seu conteúdo. As opções Mais têm a URL do wiki clone, que pode ser usada para clonar o wiki.

  2. Obtenha o ID do repositório git que suporta seu wiki. Você pode usar a API REST para obter todas as wikis do projeto.

    Por exemplo, GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1 retorna todas as wikis do projeto, para que você possa escolher qual delas excluir.

  3. Use a API REST para excluir o repositório Git de suporte. Use o ID do repositório do wiki do projeto que você encontrou na etapa anterior e verifique novamente o ID do repositório, para não remover o errado.

    Por exemplo, DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1

Atualizar um wiki offline

Você pode trabalhar offline ou em uma ramificação local para atualizar o conteúdo de um wiki provisionado e publicar como wiki de código. Para obter mais informações, consulte Clonar e atualizar páginas wiki offline.