Criar um wiki para o seu projeto

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

Neste artigo, saiba como abrir um wiki e criar um repositório Git para o seu wiki. Cada projeto de equipe tem um wiki. Use o wiki para compartilhar informações com sua equipe para entender e contribuir com seu projeto.

Cada wiki de projeto de equipe é alimentado por um repositório Git no back-end. Quando você cria um projeto de equipe, um repositório Git wiki não é criado por padrão. Crie um repositório Git para armazenar seus arquivos de Markdown wiki ou publique arquivos Markdown existentes de um repositório Git para um wiki.

Pré-requisitos

• Você deve ter um projeto de equipe. Se você ainda não tiver um projeto de equipe, crie um no Azure DevOps.
• Você deve ter pelo menos acesso básico para criar e modificar um wiki.
• Você deve ter a permissão Criar repositório para publicar código como wiki. Por predefinição, esta permissão está definida para membros do grupo Administradores de Projetos.
• Qualquer pessoa que seja membro do grupo de segurança Contribuidores pode adicionar ou editar páginas wiki. Qualquer usuário com acesso ao projeto de equipe, incluindo partes interessadas, pode visualizar o wiki.

Abra o Wiki

Você pode abrir e visualizar uma página wiki para o seu projeto.

Browser

Conecte-se ao seu projeto usando um navegador da Web suportado e escolha Wiki.

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

CLI do Azure DevOps

Você pode visualizar e abrir uma página wiki definida para um projeto usando o az devops wiki show comando. Para começar, consulte Introdução à CLI do Azure DevOps.

az devops wiki show --wiki
                      [--open]
                      [--project]
                      [--subscription]

Parâmetros

• --wiki: Obrigatório. Nome ou ID da wiki.
• --open: Opcional. Abra a página wiki no seu navegador da web.
• --project -p: Opcional. Nome ou ID do projeto.
• --assinatura: Opcional. o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Exemplo

Abra um wiki chamado 'myprojectwiki'.

az devops wiki show --wiki myprojectwiki --open

Ver uma página wiki

Para obter o conteúdo de uma página por meio da CLI do Azure DevOps, digite o az devops wiki show comando.

az devops wiki page show --path
                         --wiki
                         [--include-content]
                         [--open]
                         [--project]
                         [--subscription]
                         [--version]

Parâmetros

• --path: Obrigatório. Caminho da página wiki.
• --wiki: Obrigatório. Nome ou ID da wiki.
• --include-content: Opcional. Inclua o conteúdo da página.
• --open: Opcional. Abra a página wiki no seu navegador da web.
• --project -p: Opcional. Nome ou ID do projeto.
• --version -v: Opcional. Versão (ETag) da página wiki.

Exemplo

Obtenha o conteúdo da página wiki com o caminho 'my wiki' em um wiki chamado 'myprojectwiki'.

az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"

Criar um repositório Git wiki

Browser

Crie um novo repositório Git que armazene todas as suas páginas wiki e artefatos relacionados. Na página inicial do wiki, selecione Criar wiki do projeto. Mesmo se você usar TFVC para controle de código-fonte, você pode criar um wiki com um repositório Git.

Se você não tiver acesso para criar um repositório Git wiki ou se não tiver acesso a nenhum dos wikis existentes, a seguinte mensagem será exibida.

Seu administrador pode criar o repositório Git wiki ou você pode solicitar que eles elevem suas permissões. As partes interessadas não podem criar um wiki, pois não têm permissões para trabalhar em repositórios ou código.

O repositório Git wiki é referido como TeamProjectName.wiki. Por exemplo, se o seu projeto de equipe éfoobar, então o repositório wiki é rotulado .foobar.wiki

Nota

Se você quiser criar mais wikis, então você deve publicar o código como um wiki. Você pode configurar vários repositórios wiki em um único projeto.

Como posso ir para o repositório Git?

O TeamProjectName.wiki não aparece no menu suspenso de repositórios de Repos ou Código. Ele também não está na lista fornecida nas páginas Repositórios de Configurações > do Projeto ou Controle de Versão das Configurações > do Projeto.
No entanto, você pode acessá-lo a partir do seguinte URL:

https://dev.azure.com/<Org_Name>/<Team_Project_Name>/_git/<Wiki_Name>

Selecione Clone Wiki nas reticências perto do seletor wiki para acessar o URL do wiki.

A URL do repositório Git wiki está exposta. Copie e cole-o em seu navegador da Web para acessar o repositório Git subjacente.

CLI do Azure DevOps

Você pode criar um wiki com o comando az devops wiki create . Para começar, consulte Introdução à CLI do Azure DevOps.

Nota

Para criar mais de um wiki, você deve publicar o código como um wiki. Você pode configurar vários repositórios wiki em um único projeto.

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {codewiki, projectwiki}]
                      [--version]

Parâmetros

• mapped-path: (Necessário para o tipo codewiki ). Caminho mapeado da nova wiki. Por exemplo, você pode especificar / para publicar a partir da raiz do repositório.
• nome: (Obrigatório para o tipo codewiki ). Nome da nova wiki. Se você não especificar um nome para o tipo projectwiki, então o novo wiki será nomeado TeamProjectName.wiki.
• org: URL da organização do Azure DevOps. Você pode configurar a organização padrão usando az devops configure -d organization=ORG_URLo . Obrigatório se não estiver configurado como padrão ou coletado usando git configo . Exemplo: --org https://dev.azure.com/MyOrganizationName/.
• projeto: Nome ou ID do projeto. Você pode configurar o projeto padrão usando az devops configure -d project=NAME_OR_ID. Obrigatório se não estiver configurado como padrão ou coletado usando git configo .
• repository: (Necessário para o tipo codewiki ). Nome ou ID do repositório a partir do qual publicar o wiki.
• type: Tipo de wiki para criar. Os valores aceitos são projectwiki (padrão) e codewiki.
• versão: (Necessário para o tipo codewiki ). Nome da ramificação do repositório a partir do qual publicar o wiki de código.

Exemplo

O comando a seguir cria um wiki chamado "Fabrikam Fiber" e mostra a saída em formato de tabela.

az devops wiki create --name "Fabrikam Fiber" --output table

ID                                    Name                 Type
------------------------------------  -------------------  -----------
7edcc35b-89be-465e-855e-377ba8660af7  Fabrikam Fiber.wiki  projectWiki

Próximos passos

Adicionar e editar páginas wiki