Introdução aos wikis do projeto Azure DevOps
O Azure DevOps Projects inclui uma opção para criar um wiki de projeto.
O wiki para compartilhar informações com sua equipe para entender e contribuir com seu projeto.
Wikis são armazenados em um repositório. Nenhum wiki é provisionado automaticamente.
Pré-requisitos
Você deve ter permissão para criar um repositório para publicar código como um wiki. Embora o grupo Administradores de Projeto tenha essa permissão por padrão, ela pode ser atribuída a outras pessoas.
Para adicionar ou editar páginas wiki, você deve ser membro do grupo de Colaboradores .
Todos os membros do projeto de equipe (incluindo as partes interessadas) podem visualizar o wiki.
Criação
O seguinte artigo inclui detalhes sobre como criar um wiki: Crie um Wiki para o seu projeto.
Editando o wiki
O artigo a seguir inclui detalhes sobre como publicar um repositório Git em um wiki: Publicar um repositório Git em um wiki.
Markdown
Os Wikis de DevOps do Azure são escritos em Markdown e também podem incluir anexos de arquivo e vídeos.
Markdown é uma linguagem de marcação. O texto sem formatação inclui sintaxe de formatação. Tornou-se o padrão de facto para escrever projetos e documentação de software.
Uma das principais razões para isso é que, por ser composto de texto simples, é mais fácil mesclar da mesma forma que o código do programa é mesclado.
Ele permite que os documentos sejam gerenciados com as mesmas ferramentas usadas para criar outro código em um projeto.
Marcação com sabor do GitHub (GFM)
O GFM é uma especificação formal lançada pelo GitHub que adicionou extensões a um formato base chamado CommonMark. O GFM é amplamente utilizado dentro do GitHub e externamente. O GFM é renderizado no Azure DevOps Wikis.
Sereia
Sereia tornou-se uma extensão essencial do Markdown porque permite que diagramas sejam incluídos na documentação.
Ele supera as dificuldades de mesclar documentação, incluindo diagramas representados como arquivos binários.
Detalhes sobre a sintaxe da Sereia podem ser encontrados aqui: Mermaid Introduction.