Partilhar via


Publicar um repositório Git em um wiki

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

Você pode publicar conteúdo que já mantém em um repositório Git em um wiki do Azure DevOps. Seu repositório pode conter arquivos para um kit de desenvolvimento de software (SDK), documentação do produto, conteúdo LEIA-ME e assim por diante. Você também pode publicar vários wikis para um único projeto de equipe.

Quando você publica seus arquivos Markdown (.md) em um wiki, você ganha vários benefícios:

  • Organizar o conteúdo em uma estrutura de sequência de página gerenciada
  • Procurar e filtrar o índice
  • 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 do wiki

Para obter mais informações, consulte Wiki provisionado versus código publicado como wiki.

Este artigo descreve como adicionar e editar conteúdo publicado em um wiki usando o portal da Web do Azure DevOps e a CLI do Azure DevOps. Você também pode trabalhar offline e atualizar seu conteúdo wiki da mesma forma que colabora no código dentro de um repositório Git. Para obter mais informações, consulte Atualizar páginas wiki offline.

Pré-requisitos

Categoria Requerimentos
Acesso ao projeto Membro do projeto onde o wiki está localizado. Você pode solicitar acesso do administrador do projeto, conforme necessário.
Permissões Membro do grupo Contribuidores.
Repositório Git Um repositório Git definido em seu projeto de equipe. Idealmente, o 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.

Abra o wiki

Conecte-se ao seu projeto de DevOps do Azure usando um navegador da Web com suporte e selecione Wiki:

Captura de ecrã de uma wiki aberta no navegador e a mostrar a página de visão geral da wiki.

Se você precisar alternar seu projeto de equipe, selecione Azure DevOps para procurar todos os projetos de equipe e equipes.

Publicar um repositório Git em um wiki

Esta seção descreve como publicar seu repositório Git em um wiki. Você pode trabalhar diretamente com a interface do usuário do Azure DevOps no navegador ou usar a CLI do Azure DevOps.

Para publicar os arquivos Markdown em seu repositório Git em um wiki, siga estas etapas:

  1. Na página inicial do Wiki , selecione Publicar código como wiki:

    Captura de ecrã que mostra como selecionar a opção Publicar código como wiki no Azure DevOps.

    • Se você não vir a opção Publicar código como wiki , talvez seja necessário primeiro definir um repositório Git para seu projeto. Siga as instruções em Criar um novo repositório Git, atualize a página Wiki e retorne a este procedimento.

    • Se você já tem um wiki de projeto de equipe, você pode expandir o menu suspenso do projeto e selecionar Publicar código wiki:

      Captura de tela que mostra como selecionar a opção Publicar código como wiki para um projeto.

  2. Na caixa de diálogo Publicar código como wiki , selecione o repositório, a ramificação e a pasta que contêm os arquivos Markdown. O repositório Git deve estar dentro do projeto de equipe. Se você quiser publicar todos os arquivos Markdown no repositório em seu wiki, selecione a raiz do repositório (/) como a pasta:

    Captura de tela que mostra como configurar o novo código wiki na caixa de diálogo Publicar código como wiki.

  3. Digite um nome para o novo repositório wiki e selecione Publicar. O repositório wiki é preenchido com os arquivos e pastas Markdown incluídos no repositório selecionado.

    A imagem a seguir mostra o repositório publicado para os arquivos contidos no repositório azure-docs-sdk-node selecionado na etapa anterior:

    Captura de tela que mostra o wiki publicado criado a partir de arquivos Markdown em um repositório Git.

    O código wiki apresenta um sumário (TOC):

    • O título do sumário é derivado do nome do arquivo Markdown.
    • Os ficheiros Markdown (.md) no repositório, branch e pasta estão listados por ordem alfabética.
    • Uma página pai é criada para cada subpasta definida dentro da pasta publicada, mesmo que a pasta não contenha nenhum arquivo Markdown.

    A imagem a seguir mostra o conteúdo do sumário para o repositório azure-docs-sdk-node:

    Captura de tela do sumário do wiki de código publicado.

Ramo do Git repo mapeado para wiki

O cabeçalho da ramificação do repositório Git está associado ao wiki do código publicado. Quaisquer alterações que faças na branch e nas pastas selecionadas aparecem automaticamente na wiki de código publicada. Não há outros fluxos de trabalho envolvidos.

Nota

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 em seu repositório Git.

Editar, renomear ou excluir páginas

No portal da Web do Azure DevOps, você pode editar, renomear ou excluir uma página wiki:

  1. Selecione Repos> Ficheiros ou Ficheiros de Código > no seu projeto.

  2. Selecione a página em que quer trabalhar na lista de ficheiros.

  3. Selecione Mais opções para o arquivo e, em seguida, selecione a ação:

    Captura de tela que mostra o menu Mais opções para um arquivo wiki que inclui as ações de edição, renomeação e exclusão.

Nota

Podes gerir o teu repositório wiki da mesma forma que geres outros repositórios Git, definindo políticas de branch no branch que selecionaste para publicar na wiki. Se você não definir políticas de filial, também poderá fazer alterações e enviá-las diretamente para a filial a partir do seu portal da Web ou de um cliente.

As seções a seguir descrevem como concluir as ações com mais detalhes.

Editar uma página

Ao editar um arquivo, use os links para visualizar as alterações ou destacar as alterações feitas na versão anterior.

  • Para descartar as alterações, selecione Cancelar. Para obter mais informações sobre os recursos de Markdown suportados, consulte Orientações de sintaxe para uso de Markdown.

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

    Captura de tela da caixa de diálogo Confirmar para adicionar suas alterações ao seu repositório wiki.

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

    Captura de tela que mostra o link para criar uma solicitação pull.

Gorjeta

Caso altere o nome ou as letras maiúsculas/minúsculas de um ficheiro, atualize o ficheiro .order que faz referência ao ficheiro 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

Para mostrar uma página no índice de conteúdo da wiki, use o tipo de ficheiro Markdown (.md). Use a ação Renomear para renomear um ficheiro, incluindo alterar a extensão do ficheiro.

O exemplo a seguir renomeia o arquivo new-home-page.md para New-Home-Page.md. A página correspondente é exibida no sumário wiki com o rótulo "Nova página inicial".

Captura de ecrã que mostra como renomear um ficheiro na caixa de diálogo Renomear confirmação (commit).

Os títulos das páginas são sensíveis a maiúsculas e minúsculas e devem ser únicos dentro da pasta. O título deve ter 235 caracteres ou menos. Para obter mais informações, consulte Restrições de nomenclatura de título de página.

Eliminar uma página

Apaga qualquer ficheiro Markdown que não queiras que apareça na wiki a partir da pasta publicada. Se você incluiu o arquivo em um arquivo .order , exclua a entrada de página correspondente do arquivo .order . Para obter mais informações, consulte Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order.

Adicionar uma página ou várias páginas

Há várias maneiras de adicionar páginas ao seu wiki publicado:

  • Adicionar um arquivo à pasta raiz do wiki ou a qualquer subpasta
  • Carregue arquivos para a pasta raiz wiki ou qualquer subpasta
  • Adicione ou atualize qualquer arquivo .order para especificar a ordem das páginas no TOC da wiki

Para cada atualização, você precisa confirmar suas alterações no repositório wiki. Em seguida, atualize seu wiki para seu repositório publicado para revisar as alterações.

Adicionar uma página a partir do portal Web

Para adicionar uma página ao seu wiki publicado, siga estes passos:

  1. No portal da Web do Azure DevOps, vá para Repositórios>Arquivos ou Código>Arquivos para o repositório publicado.

  2. Selecione Mais opções para o repositório e depois selecione Novo>Ficheiro:

    Captura de tela que mostra como adicionar um arquivo ao repositório wiki publicado no portal da Web do Azure DevOps.

  3. Na caixa de diálogo, insira um nome para o novo arquivo que inclua o tipo de arquivo Markdown (.md).

    O nome do ficheiro deve corresponder ao título da página que pretende mostrar no TOC da wiki. Substitua quaisquer espaços no título da página por hífenes (-) no nome do arquivo. Os títulos das páginas são sensíveis a maiúsculas e minúsculas e devem ser únicos dentro da pasta. O título deve ter 235 caracteres ou menos. Para obter mais informações, consulte Restrições de nomenclatura de título de página.

    O exemplo a seguir adiciona um arquivo chamado Page-4.md que é exibido no sumário wiki com o título da página "Página 4".

    Captura de tela que mostra como especificar o nome do arquivo para o novo arquivo.

    Selecione Criar.

  4. Quando a página aparecer na lista de ficheiros, selecione a página e, em seguida, selecione Editar. Insira o conteúdo da página. Para obter mais informações, consulte Orientação de sintaxe para arquivos Markdown, widgets, wikis e comentários de solicitação pull.

  5. Quando terminar, adicione a nova página ao repositório publicado selecionando Confirmar.

Carregar ficheiros para uma pasta

Você também pode carregar arquivos para uma pasta no wiki publicado. Essa opção é útil quando você tem conteúdo existente que deseja adicionar.

  1. No portal da Web do Azure DevOps, vá para Repositórios>Arquivos ou Código>Arquivos para o repositório publicado.

  2. Selecione Mais opções para o repositório e, em seguida, selecione Carregar arquivo(s):

    Captura de ecrã que mostra como carregar ficheiros existentes para o repositório wiki publicado no portal Web do Azure DevOps.

  3. Na caixa de diálogo Confirmar , selecione a pasta e os arquivos que deseja carregar:

    Captura de ecrã que mostra como selecionar a pasta e os ficheiros que pretende carregar na caixa de diálogo Confirmar.

  4. Quando terminar, carregue os arquivos para o repositório publicado selecionando Confirmar.

Adicionar uma página com subpáginas

Se você quiser que uma página em seu wiki tenha subpáginas, você precisa de um arquivo Markdown e uma pasta que tenham o mesmo nome. O arquivo e a pasta devem estar na mesma pasta wiki.

  1. Crie o novo arquivo Markdown seguindo as etapas em Adicionar uma página do portal da Web.

  2. Para criar a pasta correspondente, selecione Mais opções para o repositório e depois selecione Nova>Pasta.

  3. Na caixa de diálogo Nova pasta , digite o nome da pasta, que deve ser idêntico ao nome do arquivo Markdown:

    Captura de tela que mostra como especificar a nova pasta para servir como uma página com subpáginas no sumário wiki.

    Selecione Criar.

  4. Na lista de arquivos wiki, selecione a nova pasta. Adicione um ou mais arquivos como subpáginas à pasta.

Adicionar ou atualizar o arquivo .order

Depois de adicionares ficheiros ou pastas ao repositório publicado, adiciona ou atualiza o ficheiro .order para pastas novas ou atualizadas. Atualize a sequência de páginas para garantir que os novos arquivos e pastas sejam exibidos no sumário wiki conforme o esperado.

Para obter mais informações, consulte Alterar a sequência de páginas, adicionar ou atualizar um arquivo .order. Qualquer arquivo não listado no arquivo .order é adicionado ao final da lista alfabética na sequência de páginas.

Alterar a sequência de páginas com o arquivo .order

O ficheiro raiz .order da wiki especifica a sequência de exibição das páginas no nível raiz. O arquivo é uma lista de texto simples de nomes de página que correspondem aos arquivos Markdown na pasta, como Bem-vindo, suporte, rel-2025 e assim por diante. Cada pasta dentro da wiki também tem um ficheiro .order que define a sequência de páginas dessa pasta.

Siga estas etapas para configurar um arquivo de sequência de ordem para uma pasta:

  1. Em Ficheiros de Código>, selecione Novo ficheiro. Nomeie o arquivo .order.

  2. Edite o conteúdo do arquivo para definir a sequência de exibição para os arquivos Markdown na pasta.

    Adiciona uma entrada para cada ficheiro de página na pasta que queres tornar visível para os utilizadores da wiki.

    Os títulos das páginas diferenciam entre maiúsculas e minúsculas. O texto da entrada deve corresponder ao título da página e às maiúsculas e minúsculas usadas no nome do arquivo, mas não incluir o tipo de arquivo Markdown (.md).

O exemplo a seguir mostra um arquivo .order para uma pasta com cinco arquivos:

readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts

Definir a página inicial do wiki

Quando você seleciona Wiki no portal da Web do Azure DevOps, a home page do seu wiki é aberta.

Por defeito, a primeira página que adicionas ao criar uma wiki é a página inicial da wiki. Quando a sua wiki tem várias páginas, o primeiro ficheiro na sequência alfabética é a página inicial.

Você pode especificar qual página usar como página inicial definindo a sequência de páginas no arquivo .order na raiz wiki. Coloque o nome da página inicial na primeira linha do arquivo .order raiz.

Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9

Promover pasta para página wiki

Você pode exibir uma pasta em seu repositório como uma página em seu wiki. Esse processo é conhecido como promover uma pasta para uma página.

Para esse cenário, você precisa da seguinte configuração:

  • Um arquivo Markdown (.md) em seu wiki que tem o mesmo nome da pasta.

  • O arquivo e a pasta Markdown devem estar no mesmo local na sua lista de arquivos wiki.

O exemplo a seguir mostra uma pasta e um arquivo Markdown (.md) ambos chamados Test. A presença dos pares com o mesmo nome no mesmo local cria uma página com o mesmo nome na sequência wiki:

Captura de ecrã que mostra uma pasta e um ficheiro Markdown chamado Test, que cria uma página chamada Test na sequência wiki.

Selecione uma versão wiki

Se a sua wiki tiver várias versões publicadas, a versão mais recente aparece por defeito.

Pode selecionar uma versão diferente da wiki expandindo as opções da lista suspensa e escolhendo a versão a ser exibida:

Captura de tela que mostra como selecionar uma versão específica de um código wiki no menu suspenso wiki.

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

Se já não quiser publicar um repositório Git como wiki, pode despublicar a wiki.

Aviso

Quando despublicas uma wiki, despublicas toda a wiki do código, que inclui todas as versões publicadas do repositório.

  1. Na lista da wiki, selecione a wiki que quer despublicar. Selecionar Mais opções (...) >Despublicar wiki:

    Captura de tela que mostra como selecionar a opção Cancelar publicação para um wiki no menu suspenso Mais opções.

    Depois de selecionar a ação Cancelar publicação , uma caixa de diálogo é aberta para confirmação.

  2. Na caixa de diálogo de confirmação, selecione Cancelar publicação:

    Captura de tela que mostra como cancelar a publicação de um wiki.