Wikis aprovisionadas frente al código publicado como wiki

  • Artículo

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

En Azure DevOps, puede mantener el contenido wiki en una wiki del proyecto de equipo o publicarlo como wiki de código. Con una wiki de código publicada, puede mantener varias wikis con versiones para admitir sus necesidades de contenido, aunque solo está disponible si Azure Repos está habilitado.

Aunque ambas opciones mantienen el contenido wiki en los repositorios de Git, la forma de agregar, actualizar y administrar el contenido wiki difiere.

Nota:

El código de publicación como característica wiki está disponible actualmente en Azure DevOps Server 2018 y versiones posteriores. Para versiones anteriores, solo puede aprovisionar una wiki para el proyecto de equipo.

Opciones de menú de página wiki

Con una wiki aprovisionada, puede agregar y editar páginas directamente dentro de la wiki. Todas las actualizaciones de contenido de una wiki aprovisionada se producen dentro de la wiki.

Con un código de publicación como wiki, puede agregar, editar y actualizar contenido de repositorios o código.

En la imagen siguiente se muestran las opciones de una wiki aprovisionada. No se admiten varias de estas opciones para la publicación como páginas wiki de código.

Captura de pantalla de las opciones de menú de la página wiki aprovisionada.

Por ejemplo, la opción Editar en repositorios para el código de publicación como wiki le lleva a la página Repositorio para editar esa página específica. Novedades que realice en una página de la rama seleccionada para la wiki se publicará automáticamente en la wiki.

Características admitidas y diferencias operativas

Ambos tipos de wiki admiten las siguientes características:

En la tabla siguiente se resumen esas operaciones o características que pueden diferir, en función del tipo wiki.

Operación Wiki aprovisionada Publicar código como wiki
Compatibilidad con varias wikis, wiki de nombres ✔️
Agregar o editar páginas desde archivos de repositorios>o archivos de código> ✔️
Revertir a una revisión anterior de la Wiki ✔️
Revertir a una revisión anterior de repositorios o código ✔️ ✔️
Mantenimiento de wikis con versiones ✔️
Selección de una versión wiki ✔️
Anulación de la publicación de una wiki de código ✔️

Agregar páginas

Para ambos tipos de wiki, seleccione Nueva página o Agregar subpágina. Para obtener más información, vea Agregar y editar páginas wiki.

Secuencia de páginas y lista de páginas en el panel de navegación

La wiki aprovisionada administra automáticamente la secuencia de páginas y la lista de páginas a medida que agrega o mueve páginas dentro del panel de navegación.

Para estructurar la lista de páginas en el panel de navegación de un código de publicación como wiki, defina el archivo .order en la raíz y para cada subcarpeta o página principal que contenga subpáginas.

Ambos tipos de wikis siguen la misma estructura de archivos, es solo que el código de publicación como wiki requiere que mantenga manualmente la secuencia de páginas.

Para obtener más información sobre cómo trabajar con archivos .order , consulte Wiki Git repository files and file structure (Archivos de repositorio de Git wiki y estructura de archivos).

Revisiones de página y reversión a una versión anterior

En la wiki, puede ver las revisiones de cualquier página wiki. Seleccione Revisiones o la opción de menú Ver revisiones .

Pero el proceso de reversión difiere en función del tipo de página wiki.

  • Para una página wiki aprovisionada, seleccione Revertir, como se describe en Revertir una confirmación a una página wiki aprovisionada.
  • Para una página wiki de publicación como código, trabaje desde una rama local y envíe una solicitud de incorporación de cambios para actualizar la rama desde la que trabaja.

Control de versiones y anulación de la publicación de una wiki

Con el control de versiones, puede publicar diferentes versiones de contenido en wikis distintas, en función de una rama con versiones de un repositorio de Git. El control de versiones y la anulación de la publicación de una wiki solo se admiten para wikis creadas mediante la publicación de código en una wiki. Para obtener más información, consulte Publicación de un wiki de código/Anulación de la publicación de un wiki de código.

Eliminar una wiki del proyecto

Nota:

Las API REST de wiki no admiten la eliminación de una wiki del proyecto. Por lo tanto, debe eliminar el repositorio wiki en su lugar.

  1. Clone el repositorio wiki para realizar copias de seguridad de todo su contenido. Las opciones Más tienen la dirección URL de la wiki clonada, que se puede usar para clonar la wiki.

  2. Obtenga el identificador del repositorio de Git que respalda la wiki. Puede usar la API REST para obtener todas las wikis del proyecto.

    Por ejemplo, GET https://fabrikam.visualstudio.com/sampleProject/_apis/wiki/wikis?api-version=4.1 devuelve todas las wikis del proyecto, por lo que puede elegir cuál eliminar.

  3. Use la API REST para eliminar el repositorio de Git de respaldo. Use el identificador de repositorio de la wiki del proyecto que encontró en el paso anterior y compruebe el identificador del repositorio, por lo que no quita el incorrecto.

    Por ejemplo: DELETE https://fabrikam.visualstudio.com/sampleProject /_apis/git/repositories/{repositoryId}?api-version=4.1

Actualizar una wiki sin conexión

Puede trabajar sin conexión o en una rama local para actualizar el contenido de una wiki aprovisionada y publicar como wiki de código. Para obtener más información, vea Clonar y actualizar páginas wiki sin conexión.