Publicación de un repositorio de Git en una wiki
Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018
En este inicio rápido, aprenderá a realizar las siguientes tareas:
- Abrir wiki
- Publicación de un repositorio de Git en una wiki
- Edición de páginas de una wiki publicada
- Agregar páginas a una wiki publicada
- Cambio de la secuencia de página de una wiki publicada
- Convertir una página en la página principal de wiki
El contenido que ya mantiene en un repositorio de Git se puede publicar en una wiki. Por ejemplo, podría ser contenido escrito para admitir un kit de desarrollo de software (SDK), documentación del producto o archivo LÉAME. Puede publicar varias wikis dentro de un único proyecto de equipo.
Al publicar los archivos de Markdown en una wiki, obtendrá las siguientes ventajas:
- Organización del contenido en una estructura jerárquica de páginas
- Tabla de contenido que los lectores pueden examinar y filtrar
- Publicación de nuevas versiones del contenido
- Administrar el contenido de la misma manera que administra el código base
- Los lectores pueden buscar fácilmente en la wiki mediante la característica de búsqueda wiki.
Para obtener información sobre cómo administrar los distintos tipos de wiki, consulte Diferencias entre la wiki aprovisionada y el código de publicación como wiki.
Sugerencia
Puede agregar y editar el contenido que ha publicado en una wiki mediante los pasos descritos en este artículo. O bien, también puede trabajar sin conexión y actualizar el contenido wiki de la misma manera que colabora en el código a través de un repositorio de Git. Para más información, consulte Actualización de páginas wiki sin conexión.
Requisitos previos
- Debe tener un proyecto de equipo. Si aún no tiene un proyecto de equipo, cree uno.
- Debe haber habilitado Azure Repos servicio para el proyecto.
- Debe tener un repositorio de Git definido en el proyecto de equipo. Idealmente, este repositorio contiene al menos un archivo Markdown, que quiere publicar en la wiki. Si necesita agregar un repositorio de Git, consulte Creación de un repositorio de Git en el proyecto.
- Debe tener el permiso Contribuir para publicar código como wiki. De forma predeterminada, este permiso se establece para los miembros del grupo Colaboradores.
- Cualquier persona que tenga permisos para contribuir al repositorio de Git puede agregar o editar páginas wiki.
Abrir wiki
Comience por conectarse al proyecto mediante un explorador web compatible y elija Wiki.
Elija Wiki de información general.
Si necesita cambiar el proyecto de equipo, elija Azure DevOps examinar todos los proyectos 
de equipo y equipos.
Publicación de un repositorio de Git en una wiki
Elija esta opción cuando mantenga archivos Markdown en un repositorio de Git existente y quiera publicarlos en una wiki.
Seleccione Publicar código como Wiki.
Nota
La opción Publicar código como wiki no aparecerá si el proyecto no tiene definido un repositorio de Git. Cree un nuevo repositorio de Gity, a continuación, devuelva y actualice esta página.
Si ya ha aprovisionado una wiki de proyecto de equipo, en el menú contextual de Wikis, elija Publicar wiki de código.
Elija el repositorio, la rama y la carpeta que contienen los archivos Markdown y asigne el nombre al repositorio wiki. El repositorio de Git debe estar dentro del proyecto de equipo.
Especifique la raíz del repositorio cuando quiera publicar todos los archivos Markdown del repositorio en la wiki.
Elija Publicar. El repositorio wiki se rellena con los archivos y carpetas de Markdown incluidos en el repositorio seleccionado.
Por ejemplo, la siguiente imagen muestra el repositorio publicado para los archivos contenidos en el repositorio azure-docs-sdk-node que seleccionó en el paso 2.
La tabla de contenido (TOC) de wiki contiene los siguientes archivos:
Cada archivo Markdown (tipo de archivo =.md)definido en el repositorio, rama o carpeta se muestra en orden alfabético, el título de toc se deriva del nombre del archivo Markdown.
Una página primaria para cada subcarpeta definida dentro de la carpeta publicada, incluso si no contiene ningún archivo Markdown.
Y esta es una imagen del contenido del repositorio azure-docs-sdk-node.
El responsable de la rama de repositorio de Git ahora está asignado a la wiki. Los cambios realizados dentro de la rama y las carpetas seleccionadas se reflejan automáticamente en la wiki. No hay ningún otro flujo de trabajo implicado.
Nota
Puede publicar hasta 10 wikis en total.
En el caso de la wiki que se aprovisiona con los archivos Markdown que ha agregado, ahora puede agregar o editar páginas de la misma manera que mantiene el código en el repositorio de Git.
Edición, cambio de nombre o eliminación de páginas
Para editar, cambiar el nombre o eliminar una página, abra Repos oArchivos de código.
Elija la página que desee, seleccione
Accionesy, a continuación, elija la operación que desee.
Nota
Puede administrar el repositorio wiki de la misma manera que administra cualquier otro repositorio de Git mediante la definición de directivas de rama en la rama que seleccionó para publicar en una wiki. Sin embargo, sin directivas definidas, puede realizar cambios e insertarlos directamente en la rama desde el portal web o desde un cliente.
Edición de una página
Puede usar los vínculos disponibles en modo de edición para obtener una vista previa de los cambios o resaltar los cambios realizados desde la versión anterior. Para descartar los cambios, seleccione Cancelar. Para más información sobre las características admitidas de Markdown, consulte Guía de sintaxis para el uso de Markdown.
Cuando haya terminado con las actualizaciones, elija Confirmary rellene el formulario del cuadro de diálogo Confirmar.
El sistema le presenta automáticamente un vínculo para crear una solicitud de extracción. Puede omitir este mensaje cuando edite directamente la rama wiki.
Sugerencia
Al cambiar el nombre o el caso de un archivo, querrá actualizar el archivo .order para reflejar el cambio. Para obtener más información, vaya a Cambiar la secuencia de página, agregue o actualice un archivo .order.
Cambiar el nombre de una página
Todas las páginas que quiera que aparezcan en la TOC deben tener .md como tipo de archivo. Elija Cambiar nombre para cambiar el nombre del archivo en consecuencia.
Por ejemplo, aquí se cambia el nombre new-home-page.md a New-Home-Page.md. Esta página aparece en la toc con la etiqueta "Nueva página principal".
Los títulos de página distinguen mayúsculas de minúsculas y deben ser únicos dentro de la carpeta y 235 caracteres o menos. Para otras restricciones de título, vea Restricciones de nomenclatura de títulos de página.
Eliminación de una página
Los archivos Markdown que no quiera que aparezcan en la wiki, puede eliminar de la carpeta publicada. Si ha incluido el archivo en un archivo .order, elimine su entrada del archivo .order. Para obtener más información, vaya a Cambiar la secuencia de página, agregue o actualice un archivo .order.
Agregar una página o páginas
Puede agregar páginas a la wiki publicada de la siguiente manera:
- Agregar un archivo a una carpeta raíz o subcarpeta desde el portal web
- Upload archivos a una carpeta o subcarpeta raíz
- Agregue o actualice un archivo .order para especificar la secuencia de páginas en el SITIO WEB de wiki.
Cada actualización que realice requiere que confirme los cambios en el repositorio. A continuación, puede actualizar la wiki del repositorio publicado para revisar los cambios.
Adición de una página desde el portal web
En Repos archivos o archivos de código para el repositorio publicado, seleccione Acciones y, a
continuación, elija Archivo.
Escriba un nombre para la página y asegúrese de especificar el tipo de archivo .md. El nombre de archivo debe corresponder al título de la página que desea que aparezca en la tabla de contenido, con guiones en lugar de espacios. Especifique un título único de 235 caracteres o menos. Los títulos de página distinguen mayúsculas de minúsculas. Para otras restricciones de título, vea Restricciones de nomenclatura de títulos de página.
Por ejemplo, para agregar una página que aparece en el TOC como Página 4,agregue un archivo denominado Page-4.md.
Escriba el contenido de la página. Para más información sobre las características admitidas de Markdown, consulte Guía de sintaxis para archivos, widgets, wikis y comentarios de solicitud de extracción de Markdown.
Cuando haya terminado, elija Confirmary rellene el formulario del cuadro de diálogo Confirmar.
Upload archivos a una carpeta
Si ya tiene contenido definido, puede cargarlo en una carpeta. Seleccione
Accionesy, a continuación, Upload archivos.
Rellene el formulario del cuadro de diálogo Confirmar y seleccione la carpeta y los archivos que desea cargar.
Agregar una página primaria y subpáginas
Para agregar una página primaria, primero agregará un archivo Markdown en el nivel de carpeta raíz y, a continuación, agregará una carpeta con la misma etiqueta.
Para agregar una carpeta, elija Carpetay rellene el formulario de diálogo Nueva carpeta. Especifique al menos un archivo para que se corresponda con una subpágina de la carpeta .
Agregue todos los archivos que desee como subpáginas a la carpeta.
Agregar o actualizar un archivo .order
El último paso al agregar archivos o carpetas al repositorio wiki es agregar o actualizar el archivo .order de las carpetas actualizadas. Esta acción refleja la secuencia de páginas que desea mostrar en la toc. Para obtener más información, vea Cambiar la secuencia de página, agregar o actualizar un archivo .order. Los archivos que no aparecen en el archivo .order se agregan al final de la lista alfabética, ya que su orden se establece en int. MaxValue.
Cambiar la secuencia de página, agregar o actualizar un archivo .order
Cada archivo .order define la secuencia de páginas contenida en una carpeta. El archivo raíz .order especifica la secuencia de páginas definida en el nivel raíz. Y para cada carpeta, un archivo .order define la secuencia de subpáginas agregadas a una página primaria.
Puede agregar un archivo .order de la misma manera que agrega cualquier archivo desde la página Archivos de código. Asigne al archivo el nombre .order.
A continuación, edite el contenido del archivo para reflejar la secuencia de archivos Markdown incluidos en la carpeta . Cada entrada debe reflejar el nombre de archivo, pero sin el tipo de archivo .md. Los títulos distinguen mayúsculas de minúsculas, por lo que la entrada debe coincidir con el caso usado en el nombre de archivo.
Por ejemplo:
README
page-2
page-3
Page-4
Misc content
Establecer una página principal
De forma predeterminada, el primer archivo que aparece en la raíz en orden alfabético se establece como la página principal de wiki. La página principal se abre cada vez que selecciona Wiki en el portal web.
Puede cambiar la página principal estableciendo la secuencia de página en el archivo raíz .order.
Por ejemplo, escriba el nombre de la página en la primera línea:
New home page name here
page-2
page-3
Page-4
README
Misc content
Promover carpeta a página
Para que una carpeta también sea una página, debe haber un archivo markdown con el mismo nombre que la carpeta que un elemento relacionado con la carpeta, lo que significa que tanto la carpeta como el archivo md del mismo nombre deben estar juntos.
En el ejemplo siguiente, Test tiene una carpeta y un archivo md, que crea una jerarquía dentro del árbol Wiki.
