Creación de una wiki para el proyecto

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

En este artículo, aprenderá a abrir una wiki y a crear un repositorio de Git para la wiki. Cada proyecto de equipo tiene una wiki. Use la wiki para compartir información con su equipo para comprender y contribuir al proyecto.

Cada wiki del proyecto de equipo cuenta con la tecnología de un repositorio de Git en el back-end. Al crear un proyecto de equipo, un repositorio git wiki no se crea de forma predeterminada. Cree un repositorio de Git para almacenar los archivos de Markdown wiki o publique archivos Markdown existentes desde un repositorio de Git en una wiki.

Requisitos previos

• Debe tener un proyecto de equipo. Si aún no tiene un proyecto de equipo, cree uno en Azure DevOps.
• Debe tener al menos acceso básico para crear y modificar una wiki.
• Debe tener el permiso Crear repositorio para publicar código como wiki. De forma predeterminada, este permiso se establece para los miembros del grupo de Administradores del proyecto.
• Cualquier persona que sea miembro del grupo de seguridad de Colaboradores puede agregar o editar páginas wiki. Cualquier usuario con acceso al proyecto de equipo, incluidas las partes interesadas, puede ver la wiki.

Abrir la Wiki

Browser

Conéctese al proyecto mediante un explorador web compatible y elija Wiki.

Si necesita cambiar el proyecto de equipo, elija Azure DevOps para examinar todos los proyectos y equipos de equipo.

CLI de Azure DevOps

Puede ver y abrir una página wiki definida para un proyecto mediante el az devops wiki show comando . Para empezar, consulte Introducción a la CLI de Azure DevOps.

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

Parámetros

• --wiki: obligatorio. Nombre o identificador de la wiki.
• --open: opcional. Abra la página wiki en el explorador web.
• --project -p: Opcional. Nombre o identificador del proyecto.
• --subscription: opcional. Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Ejemplo

Abra una wiki denominada "myprojectwiki".

az devops wiki show --wiki myprojectwiki --open

Ver una página wiki

Para obtener el contenido de una página a través de la CLI de Azure DevOps, escriba el az devops wiki show comando .

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

Parámetros

• --path: obligatorio. Ruta de acceso de la página wiki.
• --wiki: obligatorio. Nombre o identificador de la wiki.
• --include-content: opcional. Incluya contenido de la página.
• --open: opcional. Abra la página wiki en el explorador web.
• --project -p: Opcional. Nombre o identificador del proyecto.
• --version -v: opcional. Versión (ETag) de la página wiki.

Ejemplo

Obtenga contenido de la página wiki con la ruta de acceso "mi wiki" en una wiki denominada "myprojectwiki".

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

Creación de un repositorio de Git wiki

Browser

Cree un nuevo repositorio de Git que almacene todas las páginas wiki y artefactos relacionados. En la página de aterrizaje de wiki, seleccione Crear wiki del proyecto. Incluso si usa TFVC para el control de código fuente, puede crear una wiki con un repositorio de Git.

Si no tiene acceso para crear un repositorio git wiki o si no tiene acceso a ninguna de las wikis existentes, aparece el siguiente mensaje.

El administrador puede crear el repositorio de Git wiki o puede solicitar que eleva los permisos. Las partes interesadas no pueden crear una wiki, ya que no tienen permisos para trabajar en repositorios o código.

El repositorio git wiki se conoce como TeamProjectName.wiki. Por ejemplo, si el proyecto de equipo es foobar , el repositorio wiki se etiqueta foobar.wiki.

Nota:

Si desea crear más wikis, debe publicar código como wiki. Puede configurar varios repositorios wiki en un solo proyecto.

¿Cómo puedo ir al repositorio de Git?

TeamProjectName.wiki no aparece en el menú desplegable de repositorios de Repositorios o Código. Tampoco se encuentra en la lista proporcionada desde las páginas Project Configuración > Repositorios o Project Configuración > Control de versiones.
Sin embargo, puede acceder a ella desde la siguiente dirección URL:

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

Seleccione Clonar wiki en los puntos suspensivos cerca del selector de wiki para acceder a la dirección URL de wiki.

Se expone la dirección URL del repositorio git wiki. Copie y péguelo en el explorador web para acceder al repositorio de Git subyacente.

CLI de Azure DevOps

Puede crear una wiki con el comando az devops wiki create . Para empezar, consulte Introducción a la CLI de Azure DevOps.

Nota:

Para crear más de una wiki, debe publicar código como wiki. Puede configurar varios repositorios wiki en un solo proyecto.

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

Parámetros

• mapped-path: (obligatorio para el tipo codewiki ). Ruta de acceso asignada de la nueva wiki. Por ejemplo, puede especificar / que se publique desde la raíz del repositorio.
• name: (obligatorio para el tipo codewiki ). Nombre de la nueva wiki. Si no especifica un nombre para el tipo projectwiki, la nueva wiki se denomina TeamProjectName.wiki.
• org: la URL de la organización de Azure DevOps. Puede configurar la organización predeterminada mediante az devops configure -d organization=ORG_URL. Obligatorio si no está configurado como predeterminado o seleccionado mediante git config. Ejemplo: --org https://dev.azure.com/MyOrganizationName/.
• project: nombre o identificador del proyecto. Puede configurar el proyecto predeterminado mediante az devops configure -d project=NAME_OR_ID. Obligatorio si no está configurado como predeterminado o seleccionado mediante git config.
• repository: (obligatorio para el tipo codewiki ). Nombre o identificador del repositorio desde el que publicar la wiki.
• type: tipo de wiki que se va a crear. Los valores aceptados son projectwiki (valor predeterminado) y codewiki.
• version: (obligatorio para el tipo codewiki ). Nombre de la rama del repositorio desde el que publicar la wiki de código.

Ejemplo

El siguiente comando crea una wiki denominada "Fabrikam Fiber" y muestra la salida en formato de tabla.

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

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

Pasos siguientes

Adición y edición de páginas de wiki