Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Serviços de DevOps do Azure | Azure DevOps Server | Azure DevOps Server 2022 | Azure DevOps Server 2020
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:
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:
Na página inicial do Wiki , selecione Publicar código como wiki:
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:
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:
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:
O código wiki apresenta um sumário (TOC):
- O título do sumário é derivado do nome do arquivo Markdown.
- Os arquivos Markdown (.md) no repo/branch/folder são listados em 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:
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 feitas dentro da ramificação e pastas selecionadas são automaticamente refletidas no wiki de código publicado. 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:
Em seu projeto, selecione Repositórios>Arquivos ou Arquivos de código>.
Na lista de ficheiros, selecione a página em que pretende trabalhar.
Selecione Mais opções
para o arquivo e, em seguida, selecione a ação:
Nota
Você pode gerenciar seu repositório wiki da mesma forma que gerencia outros repositórios Git definindo políticas de ramificação na ramificação que você selecionou para publicar no 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:
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.
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
Todas as páginas que você deseja exibir no sumário wiki devem usar o tipo de arquivo Markdown (.md). Você pode usar a ação Renomear para renomear um arquivo, incluindo alterar a extensão do arquivo.
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".
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
Qualquer arquivo Markdown que você não queira que apareça no wiki, você pode excluir 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:
No portal da Web do Azure DevOps, vá para Repositórios>Arquivos ou Código>Arquivos para o repositório publicado.
Selecione Mais opções
para o repositório e, em seguida, selecione Novo>arquivo:
Na caixa de diálogo, insira um nome para o novo arquivo que inclua o tipo de arquivo Markdown (.md).
O nome do arquivo deve corresponder ao título da página que você deseja exibir no sumário 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".
Selecione Criar.
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.
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.
No portal da Web do Azure DevOps, vá para Repositórios>Arquivos ou Código>Arquivos para o repositório publicado.
Selecione Mais opções
para o repositório e, em seguida, selecione Carregar arquivo(s):
Na caixa de diálogo Confirmar , selecione a pasta e os arquivos que deseja carregar:
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.
Crie o novo arquivo Markdown seguindo as etapas em Adicionar uma página do portal da Web.
Para criar a pasta correspondente, selecione Mais opções
para o repositório e, em seguida, selecione Nova>pasta.Na caixa de diálogo Nova pasta , digite o nome da pasta, que deve ser idêntico ao nome do arquivo Markdown:
Selecione Criar.
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 adicionar arquivos ou pastas ao repositório publicado, a última etapa é adicionar ou atualizar o arquivo .order para quaisquer 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 .order na raiz do wiki especifica a sequência de exibição para 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 do wiki também tem um arquivo .order que define a sequência de páginas para essa pasta.
Siga estas etapas para configurar um arquivo de sequência de ordem para uma pasta:
Na página Arquivos de código>, selecione Novo arquivo. Nomeie o arquivo .order.
Edite o conteúdo do arquivo para definir a sequência de exibição para os arquivos Markdown na pasta.
Adicionar uma entrada corresponde a cada arquivo de paginação na pasta que você deseja tornar visível para os usuários do 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 padrão, a primeira página que você adiciona quando cria um wiki é definida como a página inicial do wiki. Quando seu wiki tem várias páginas, o primeiro arquivo na sequência alfabética é definido como 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:
Selecione uma versão wiki
Se o seu wiki tiver várias versões publicadas, a versão mais recente é mostrada por padrão.
Pode selecionar uma versão diferente da wiki expandindo as opções da lista suspensa e escolhendo a versão a ser exibida:
Cancelar a publicação de um wiki de código
Se você não quiser mais que um repositório Git seja publicado como um wiki, você pode cancelar a publicação do wiki.
Aviso
A não publicação de um wiki despublica todo o código wiki, que inclui todas as versões publicadas do repositório.
Na lista wiki, selecione a wiki que deseja cancelar a publicação, selecione Mais opções (...) >Cancelar publicação do wiki:
Depois de selecionar a ação Cancelar publicação , uma caixa de diálogo é aberta para confirmação.
Na caixa de diálogo de confirmação, selecione Cancelar publicação:
