Nota
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
Puede publicar contenido que ya mantiene en un repositorio de Git en una wiki de Azure DevOps. El repositorio puede contener archivos para un kit de desarrollo de software (SDK), documentación del producto, contenido del archivo README, entre otros. También puede publicar varias wikis para un solo proyecto de equipo.
Al publicar los archivos markdown (.md) en una wiki, obtendrá varias ventajas:
- Organización del contenido en una estructura de secuencia de página administrada
- Examinar y filtrar la tabla de contenido
- Publicar nuevas versiones del contenido
- Administrar el contenido de la misma manera que administra la base de código
- Buscar en la wiki fácilmente mediante la característica de búsqueda wiki
Para más información, consulte Wiki aprovisionada frente al código publicado como wiki.
En este artículo se describe cómo agregar y editar contenido publicado en una wiki mediante el portal web de Azure DevOps y la CLI de Azure DevOps. También puede trabajar sin conexión y actualizar el contenido wiki de la misma manera que colabora en el código dentro de un repositorio de Git. Para obtener más información, vea Actualizar páginas wiki sin conexión.
Requisitos previos
Categoría | Requisitos |
---|---|
Acceso al proyecto | Miembro del proyecto donde se encuentra la wiki. Puede solicitar acceso desde el administrador del proyecto, según sea necesario. |
Permisos | Miembro del grupo de Colaboradores. |
Repositorio Git | Un repositorio de Git definido en el proyecto de equipo. Idealmente, el repositorio contiene al menos un archivo Markdown que desea publicar en la wiki. Para obtener más información, consulte Creación de un nuevo repositorio de Git en el proyecto. |
Abrir la wiki
Conéctese al proyecto de Azure DevOps mediante un explorador web compatible y seleccione Wiki:
Si necesita cambiar el proyecto de equipo, seleccione Azure DevOps para examinar todos los proyectos y equipos de equipo.
Publicación de un repositorio de Git en una wiki
En esta sección se describe cómo publicar el repositorio de Git en una wiki. Puede trabajar directamente con la interfaz de usuario de Azure DevOps en el explorador o usar la CLI de Azure DevOps.
Para publicar los archivos Markdown en el repositorio de Git en una wiki, siga estos pasos:
En la página de aterrizaje wiki , seleccione Publicar código como wiki:
Si no ve la opción Publicar código como wiki , es posible que deba definir primero un repositorio de Git para el proyecto. Siga las instrucciones de Creación de un nuevo repositorio de Git, actualización de la página Wiki y, a continuación, vuelva a este procedimiento.
Si ya tiene una wiki de proyecto de equipo, puede expandir el menú desplegable del proyecto y seleccionar Publicar wiki de código:
En el cuadro de diálogo Publicar código como wiki , seleccione el repositorio, la rama y la carpeta que contienen los archivos Markdown. El repositorio de Git debe estar dentro del proyecto de equipo. Si desea publicar todos los archivos Markdown en el repositorio en la wiki, seleccione la raíz del repositorio (
/
) como carpeta:Escriba un nombre para el nuevo repositorio wiki y seleccione Publicar. El repositorio wiki se rellena con los archivos y carpetas de Markdown incluidos en el repositorio seleccionado.
En la imagen siguiente se muestra el repositorio publicado para los archivos contenidos en el repositorio azure-docs-sdk-node seleccionado en el paso anterior:
La wiki de código incluye una tabla de contenido (TOC):
- El título de TOC se deriva del nombre del archivo Markdown.
- Los archivos Markdown (.md) en el repositorio/rama/carpeta se muestran en orden alfabético.
- Se crea una página primaria para cada subcarpeta definida dentro de la carpeta publicada, incluso si la carpeta no contiene ningún archivo Markdown.
En la imagen siguiente se muestra el contenido de TOC para el repositorio azure-docs-sdk-node:
Rama del repositorio de Git asignada a la wiki
La cabeza de la rama del repositorio de Git se vincula con la wiki del código que se ha publicado. Los cambios realizados en la rama y las carpetas seleccionadas se reflejan automáticamente en la wiki del código publicado. No hay otros flujos de trabajo implicados.
Nota:
Puede publicar hasta 10 ramas por wiki de código publicado.
Para la wiki aprovisionada con los archivos de Markdown adicionales, puede agregar o editar páginas de la misma manera que mantiene el código en el repositorio de Git.
Editar, cambiar el nombre o eliminar páginas
En el portal web de Azure DevOps, puede editar, cambiar el nombre o eliminar una página wiki:
En su proyecto, seleccione Repos>Archivos o Archivos de código>.
En la lista de archivos, seleccione la página en la que desea trabajar.
Seleccione Más opciones
para el archivo y, a continuación, seleccione la acción:
Nota:
Puede administrar el repositorio wiki de la misma manera que administra otro repositorio de Git mediante la definición de directivas de rama en la rama que seleccionó para publicar en la wiki. Si no define directivas de rama, también puede realizar cambios e insertarlas directamente en la rama desde el portal web o desde un cliente.
En las secciones siguientes se describe cómo completar las acciones con más detalle.
Edición de una página de Pages
Al editar un archivo, use los vínculos para obtener una vista previa de los cambios o resaltar los cambios realizados en la versión anterior.
Para descartar los cambios, seleccione Cancelar. Para obtener más información sobre las características de Markdown admitidas, consulte Instrucciones de sintaxis para el uso de Markdown.
Cuando haya terminado, agregue un comentario sobre las actualizaciones y seleccione Confirmar:
El sistema le presenta automáticamente un vínculo para crear una solicitud de incorporación de cambios. Puede omitir este mensaje cuando edite directamente la rama wiki.
Sugerencia
Si cambia el nombre o el caso de un archivo, actualice el archivo .order que hace referencia al archivo para reflejar el cambio. Para obtener más información, vea Cambiar la secuencia de páginas, agregar o actualizar un archivo .order.
Cambiar el nombre de una página
Todas las páginas que desea mostrar en el TOC wiki deben usar el tipo de archivo Markdown (.md). Puede usar la acción Cambiar nombre para cambiar el nombre de un archivo, incluido el cambio de la extensión de archivo.
En el ejemplo siguiente se cambia el nombre del archivo new-home-page.md a New-Home-Page.md. La página correspondiente se muestra en el TOC wiki con la etiqueta "Nueva página principal".
Los títulos de página son sensibles a mayúsculas y minúsculas y deben ser únicos dentro de la carpeta. El título debe tener 235 caracteres o menos. Para obtener más información, consulte Restricciones de nomenclatura de títulos de página.
Eliminar una página
Cualquier archivo Markdown que no quiera que aparezca en la wiki, puede eliminar de la carpeta publicada. Si incluyó el archivo en un archivo .order , elimine la entrada de página correspondiente del archivo .order . Para obtener más información, vea Cambiar la secuencia de páginas, agregar o actualizar un archivo .order.
Agregar una página o varias páginas
Hay varias maneras de agregar páginas a la wiki publicada:
- Agregar un archivo a la carpeta raíz wiki o a cualquier subcarpeta
- Cargar archivos en la carpeta raíz wiki o en cualquier subcarpeta
- Agregue o actualice cualquier archivo .order para especificar la secuencia de páginas en la WIKI TOC.
Para cada actualización, debe confirmar los cambios en el repositorio wiki. A continuación, actualice la wiki del repositorio publicado para revisar los cambios.
Adición de una página desde el portal web
Para agregar una página a la wiki publicada, siga estos pasos:
En el portal web de Azure DevOps, vaya a Repos>Archivos o Código>Archivos para el repositorio publicado.
Seleccione Más opciones
para el repositorio y, a continuación, seleccione Nuevo>archivo:
En el cuadro de diálogo, escriba un nombre para el nuevo archivo que incluya el tipo de archivo Markdown (.md).
El nombre de archivo debe corresponder al título de la página que desea mostrar en la WIKI TOC. Reemplace los espacios del título de página por guiones (
-
) en el nombre de archivo. Los títulos de página son sensibles a mayúsculas y minúsculas y deben ser únicos dentro de la carpeta. El título debe tener 235 caracteres o menos. Para obtener más información, consulte Restricciones de nomenclatura de títulos de página.En el ejemplo siguiente se agrega un archivo denominado Page-4.md que se muestra en el TOC wiki con el título de página "Página 4".
Selecciona Crear.
Cuando aparezca la página en la lista de archivos, seleccione la página y, a continuación, seleccione Editar. Escriba el contenido de la página. Para obtener más información, consulte Instrucciones de sintaxis para archivos, widgets, wikis y comentarios de solicitud de incorporación de cambios.
Cuando haya terminado, agregue la nueva página al repositorio publicado seleccionando Confirmar.
Cargar archivos a una carpeta
También puede cargar archivos en una carpeta en la wiki publicada. Esta opción es útil cuando tiene contenido existente que desea agregar.
En el portal web de Azure DevOps, vaya a Repos>Archivos o Código>Archivos para el repositorio publicado.
Seleccione Más opciones
para el repositorio y, a continuación, seleccione Cargar archivos:
En el cuadro de diálogo Confirmar , seleccione la carpeta y los archivos que desea cargar:
Cuando haya terminado, cargue los archivos en el repositorio publicado seleccionando Confirmar.
Agregar una página que tenga subpáginas
Si desea que una página de la wiki tenga subpáginas, necesita un archivo y una carpeta markdown que tengan el mismo nombre. El archivo y la carpeta deben estar en la misma carpeta wiki.
Cree el nuevo archivo Markdown siguiendo los pasos descritos en Agregar una página desde el portal web.
Para crear la carpeta correspondiente, seleccione Más opciones
para el repositorio y, a continuación, seleccione Nueva>carpeta.
En el cuadro de diálogo Nueva carpeta , escriba el nombre de la carpeta, que debe ser idéntico al nombre de archivo de Markdown:
Selecciona Crear.
En la lista de archivos wiki, seleccione la nueva carpeta. Agregue uno o varios archivos como subpáginas a la carpeta.
Agregar o actualizar el archivo .order
Después de agregar archivos o carpetas al repositorio publicado, el último paso es agregar o actualizar el archivo .order para las carpetas nuevas o actualizadas. Actualice la secuencia de páginas para asegurarse de que los nuevos archivos y carpetas se muestran en el TOC wiki según lo previsto.
Para obtener más información, vea Cambiar la secuencia de páginas, agregar o actualizar un archivo .order. Cualquier archivo que no aparezca en el archivo .order se agrega al final de la lista alfabética en la secuencia de páginas.
Cambiar la secuencia de páginas con el archivo .order
El archivo .order de la raíz wiki especifica la secuencia de visualización de las páginas en el nivel raíz. El archivo es una lista de texto sin formato de nombres de página que corresponden a los archivos Markdown de la carpeta, como Welcome, support, rel-2025, etc. Cada carpeta de la wiki también tiene un archivo .order que define la secuencia de páginas de esa carpeta.
Siga estos pasos para configurar un archivo de secuencia de pedidos para una carpeta:
En la página Archivos de código>, seleccione Nuevo archivo. Asigne al archivo el nombre .order.
Edite el contenido del archivo para definir la secuencia de visualización de los archivos Markdown en la carpeta .
Agregar una entrada que corresponda a cada archivo de página de la carpeta que desea hacer visible a los usuarios Wiki.
Los títulos de página distinguen mayúsculas de minúsculas. El texto de entrada debe coincidir con el título de la página y el caso usados en el nombre de archivo, pero no incluya el tipo de archivo Markdown (.md).
En el ejemplo siguiente se muestra un archivo .order para una carpeta con cinco archivos:
readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
Establecer la página principal de wiki
Al seleccionar Wiki en el portal web de Azure DevOps, se abre la página principal de la wiki.
De forma predeterminada, la primera página que agregue al crear una wiki se establece como la página principal de wiki. Cuando la wiki tiene varias páginas, el primer archivo de la secuencia alfabética se establece como página principal.
Puede especificar qué página usar como página principal estableciendo la secuencia de páginas en el archivo .order en la raíz wiki. Coloque el nombre de la página principal en la línea superior del archivo .order raíz:
Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9
Convertir carpeta en página wiki
Puede mostrar una carpeta en el repositorio como una página en la wiki. Este proceso se conoce como promoción de una carpeta a una página.
Para este escenario, necesita la siguiente configuración:
Un archivo Markdown (.md) en la wiki que tenga el mismo nombre que la carpeta.
El archivo y la carpeta Markdown deben estar ubicados al mismo nivel en la lista de archivos de tu wiki.
En el ejemplo siguiente se muestra una carpeta y un archivo Markdown (.md) denominados Test. La existencia de los pares con el mismo nombre en la misma ubicación crea una página con el mismo nombre en la secuencia wiki.
Selección de una versión wiki
Si la wiki tiene varias versiones publicadas, la versión más reciente se muestra de forma predeterminada.
Para seleccionar otra versión wiki, expanda la lista desplegable de ramas y seleccione la versión que desea mostrar.
Anulación de la publicación de una wiki de código
Si ya no desea que un repositorio de Git se publique como wiki, puede cancelar la publicación de la wiki.
Advertencia
Al anular la publicación de una wiki, se anula la publicación de todo el código wiki, que incluye todas las versiones publicadas del repositorio.
En la lista wiki, seleccione la wiki que desea anular la publicación, seleccione Más opciones (...) >Wiki de anulación de la publicación:
Después de seleccionar la acción Cancelar publicación , se abre un cuadro de diálogo para la confirmación.
En el cuadro de diálogo de confirmación, seleccione Cancelar publicación: