Publicar um repositório Git em um wiki

  • Artigo

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

Você pode publicar conteúdo que já mantém em um repositório Git em um wiki. Por exemplo, esse conteúdo pode ser suporte ao SDK (kit de desenvolvimento de software), documentação do produto ou um arquivo README. Você também pode publicar vários wikis em um único projeto de equipe.

Ao publicar seus arquivos Markdown em um wiki, você obtém os seguintes benefícios:

  • Organizar o conteúdo em uma estrutura de página hierárquica
  • Procurar e filtrar o sumário
  • Publicar novas versões do conteúdo
  • Gerencie o conteúdo da mesma forma que gerencia sua base de código
  • Pesquise o wiki facilmente usando o recurso de pesquisa wiki

Para obter mais informações, consulte Código provisionado vs. publicado como wiki.

Dica

Você pode adicionar e editar o conteúdo publicado em um wiki usando as etapas deste artigo. Você também pode trabalhar offline e atualizar o conteúdo do wiki da mesma forma que colabora no código por meio de um repositório Git. Para obter mais informações, consulte Atualizar páginas wiki offline.

Pré-requisitos

  • Tenha um projeto de equipe. Se você não tiver um, crie um projeto agora.
  • Habilite o serviço Azure Repos para seu projeto.
  • Tenha um repositório Git definido em seu projeto de equipe. Idealmente, esse repositório contém pelo menos um arquivo Markdown, que você deseja publicar em seu wiki. Para obter mais informações, consulte Criar um novo repositório Git em seu projeto.
  • Ter a permissão Contribuir para publicar código como wiki. Por padrão, essa permissão é definida para membros do grupo Colaboradores. Qualquer pessoa que tenha permissões para contribuir com o repositório Git pode adicionar ou editar páginas wiki.

Abrir wiki

  1. Entre na sua organização (https://dev.azure.com/{yourorganization}), abra o projeto e selecione Wiki de Visão Geral>.

    Captura de tela mostrando a seleção da guia wiki.

Se você precisar alternar projetos, selecione Azure DevOps para procurar todos os projetos.

Publicar um repositório Git em um wiki

Execute as etapas a seguir ao manter arquivos Markdown em um repositório Git existente e quiser publicá-los em um wiki.

  1. Selecione Publicar código como wiki.

    Captura de tela mostrando o botão destacado, Publicar código como wiki.

    Observação

    A opção Publicar código como wiki não aparecerá se o projeto não tiver um repositório Git definido. Crie um novo repositório Git e, em seguida, retorne e atualize esta página.

  2. Se você já provisionou um wiki de projeto de equipe, selecione Publicar wiki de código.

    Captura de tela mostrando a opção Publicar código como menu wiki.

  3. Escolha o repositório, a ramificação e a pasta que contêm os arquivos Markdown e insira um nome para o repositório wiki. O repositório Git deve estar dentro do projeto de equipe.

    Captura de tela mostrando o nome inserido para o repositório wiki.

    Especifique a raiz do repositório quando quiser publicar todos os arquivos Markdown no repositório em seu wiki.

  4. Selecione Publicar. O repositório wiki é preenchido com os arquivos e pastas Markdown incluídos no repositório selecionado.

    Por exemplo, a imagem a seguir mostra o repositório publicado para os arquivos contidos no repositório azure-docs-sdk-node que você selecionou na Etapa 2.

    Captura de tela do wiki publicado dos arquivos Markdown do repositório existente.

    O sumário wiki (TOC) contém os seguintes arquivos:

    • Cada arquivo Markdown (tipo de arquivo= .md) definido no repositório/ramificação/pasta é listado em ordem alfabética, o título do sumário é derivado do nome do arquivo Markdown.

    • Uma página pai para cada subpasta definida na pasta publicada, mesmo que ela não contenha nenhum arquivo Markdown.

      A imagem a seguir mostra o conteúdo do repositório azure-docs-sdk-node.

      Captura de tela do repositório com arquivos Markdown publicados no wiki.

O cabeçalho da ramificação do repositório Git é mapeado para o wiki. Quaisquer alterações feitas na ramificação e nas pastas selecionadas são refletidas automaticamente no wiki. Não há outros fluxos de trabalho envolvidos.

Observação

Você pode publicar até 10 ramificações por wiki de código publicado.

Para o wiki provisionado com os arquivos Markdown extras, você pode adicionar ou editar páginas da mesma forma que mantém o código no repositório Git.

Editar, renomear ou excluir páginas

Siga os passos a seguir para editar, renomear ou excluir uma página wiki.

  1. Em seu projeto, abra Arquivos Repos> ou Arquivos de Código.>

  2. Escolha a página desejada, selecione Ações e escolha a operação.

    Captura de tela das opções de ação da wiki, Editar, renomear ou excluir.

Observação

Gerencie seu repositório wiki da mesma forma que você gerencia qualquer outro repositório Git, definindo políticas de branch no branch que você selecionou para publicar em um wiki. Mas, sem nenhuma política definida, você pode fazer alterações e enviá-las diretamente para a ramificação do portal da Web ou de um cliente.

Editar uma página do

Use os links disponíveis no modo de edição para visualizar suas alterações ou realçar as alterações feitas na versão anterior. Para descartar suas alterações, selecione Cancelar. Para obter mais informações sobre os recursos de Markdown com suporte, consulte Diretrizes de sintaxe para o uso de Markdown.

  1. Quando terminar, adicione um comentário sobre suas atualizações e selecione Confirmar.

    Captura de tela da caixa de diálogo Confirmar.

    O sistema apresenta automaticamente um link para criar uma solicitação de pull. Você pode ignorar esta mensagem quando estiver editando diretamente a ramificação wiki.

    Captura de tela de Criar um link de solicitação de pull.

Dica

Ao alterar o nome ou maiúsculas e minúsculas de um arquivo, atualize o .order arquivo para refletir a alteração. Para obter mais informações, consulte Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order.

Renomear uma página

Todas as páginas que você deseja que apareçam no sumário devem ser do tipo .mdde arquivo .

  1. Selecione Renomear para renomear o arquivo de acordo.

Por exemplo, na imagem a seguir, renomeamos new-home-page.md para New-Home-Page.md. Esta página aparece no sumário com o rótulo "Nova página inicial".

Captura de tela da caixa de diálogo Renomear confirmação.

Os títulos das páginas diferenciam maiúsculas de minúsculas e devem ser exclusivos dentro da pasta e ter 235 caracteres ou menos. Para obter mais informações sobre outras restrições de título, consulte Restrições de nomenclatura de título de página.

Excluir uma página

Você pode excluir todos os arquivos Markdown que não deseja que apareçam no wiki da pasta publicada. Se você incluiu o arquivo em um .order arquivo, exclua sua entrada do .order arquivo. Para obter mais informações, consulte Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order.

Adicionar uma página ou páginas

Você pode adicionar as seguintes páginas ao seu wiki publicado:

  • Adicionar um arquivo a uma pasta raiz ou subpasta do portal da Web
  • Carregar arquivos em uma pasta ou subpasta raiz
  • Adicionar ou atualizar um .order arquivo para especificar a sequência de páginas no sumário wiki

Cada atualização exige que você confirme suas alterações no repositório. Em seguida, você pode atualizar seu wiki para seu repositório publicado para revisar as alterações.

Adicionar uma página do portal da Web

  1. Em Arquivos Repos>ou Arquivos de Código>do repositório publicado, selecione Ações e, em seguida, escolha Arquivo.

    Captura de tela da adição de uma página ao wiki a partir do portal da web.

  2. Digite um nome para a página, certifique-se de especificar o tipo de .md arquivo. O nome do arquivo deve corresponder ao título da página que você deseja que apareça no sumário, com traços no lugar de espaços. Especifique um título exclusivo de 235 caracteres ou menos. Os títulos de página diferenciam maiúsculas de minúsculas. Para obter mais informações sobre outras restrições de título, consulte Restrições de nomenclatura de título de página.

    Por exemplo, para adicionar uma página que aparece no sumário como Página 4, adicione um arquivo chamado Page-4.md.

    Captura de tela mostrando a caixa de diálogo do novo arquivo com o botão Criar.

  3. Insira o conteúdo da página. Para obter mais informações, consulte Diretrizes de sintaxe para arquivos Markdown, widgets, wikis e comentários de solicitação de pull.

  4. Quando terminar, selecione Confirmar.

Carregar arquivos em uma pasta

  1. Se você já tiver conteúdo existente, poderá carregá-lo em uma pasta. Selecione Ações e, em seguida, escolha Carregar arquivo(s).

    Captura de tela mostrando a seleção destacada, Carregar arquivos.

  2. Preencha o formulário de diálogo Confirmar , selecionando a pasta e os arquivos que deseja carregar.

    Captura de tela mostrando a caixa de diálogo Confirmar para carregar arquivos.

Adicionar uma página principal e subpáginas

Para adicionar uma página pai, primeiro adicione um arquivo Markdown no nível da pasta raiz e, em seguida, adicione uma pasta com o mesmo rótulo.

  1. Para adicionar uma pasta, selecione Pasta e preencha o formulário de diálogo Nova Pasta . Especifique pelo menos um arquivo para corresponder a uma subpágina na pasta.

    Captura de tela da caixa de diálogo Criar pasta.

  2. Adicione todos os arquivos que você deseja como subpáginas à pasta.

Adicionar ou atualizar um arquivo .order

A última etapa ao adicionar arquivos ou pastas ao repositório wiki é adicionar ou atualizar o .order arquivo das pastas atualizadas. Essa ação reflete a sequência de páginas que você deseja mostrar no sumário. Para obter detalhes, consulte Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order. Todos os .order arquivos que não estão listados no arquivo são adicionados ao final da lista alfabética, pois sua ordem é definida como int.MaxValue.

Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order

Cada .order arquivo define a sequência de páginas contidas em uma pasta. O arquivo raiz .order especifica a sequência de páginas definida no nível raiz. Para cada pasta, um .order arquivo define a sequência de subpáginas adicionadas a uma página pai.

  1. Você pode adicionar um .order arquivo da mesma forma que adiciona qualquer arquivo da página Arquivos de código>. Dê o nome .order para o arquivo.

  2. Edite o conteúdo do arquivo para refletir a sequência de arquivos Markdown contidos na pasta. Cada entrada deve espelhar o nome do arquivo, mas sem o tipo de .md arquivo. Os títulos diferenciam maiúsculas de minúsculas, portanto, a entrada deve corresponder às maiúsculas e minúsculas usadas no nome do arquivo.

Por exemplo:

README
page-2
page-3
Page-4
Misc content

Definir uma página inicial

Por padrão, o primeiro arquivo que aparece na raiz em ordem alfabética é definido como a página inicial do wiki. Quando você seleciona Wiki no portal da Web, a home page é aberta.

  1. Altere a página inicial definindo a sequência de páginas dentro do arquivo raiz .order .

Por exemplo, insira o nome da página na primeira linha.

New home page name here
page-2
page-3
Page-4
README
Misc content

Promover pasta para página

Para que uma pasta também seja uma página, você precisa de um arquivo Markdown com o mesmo nome da pasta, definido como um irmão da pasta. Portanto, tanto a pasta quanto o .md arquivo com o mesmo nome devem ficar um ao lado do outro.

Conforme exibido no exemplo a seguir, Test tem uma pasta e um .md arquivo, o que cria uma hierarquia dentro da árvore wiki.

Captura de tela mostrando a promoção de uma pasta para uma página.

Selecione uma versão wiki

Para selecionar uma versão wiki, escolha a versão nas opções de ramificação da página wiki.

Captura de tela mostrando uma versão wiki selecionada no menu suspenso wiki.

Cancelar a publicação de um wiki de código

Se você não quiser mais que um repositório seja publicado como um wiki, poderá optar por cancelar a publicação.

Aviso

Cancelar a publicação de um wiki cancela a publicação de todo o wiki de código, que inclui todas as versões do repositório que você publicou anteriormente.

  1. Selecione o wiki que você deseja cancelar a publicação, abra o menu de contexto e selecione Cancelar publicação do wiki.

    Captura de tela da caixa de diálogo de confirmação de cancelar a publicação de uma wiki.

  2. Confirme que deseja cancelar a publicação do wiki escolhendo Cancelar publicação.

    Captura de tela do wiki de despublicação.