Acerca de wikis, archivos LÉAME y Markdown

  • Artículo

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

Para admitir el equipo o colaboradores en el proyecto, use Markdown para agregar formato enriquecido, tablas e imágenes al proyecto de equipo. Puede usar el formato Markdown en una wiki del proyecto de equipo, el contenido que agregue a un panel, el archivo LÉAME del proyecto de equipo u otro archivo LÉAME del repositorio.

Wiki

Use la wiki del proyecto de equipo para compartir información con otros miembros del equipo. Al aprovisionar una wiki desde cero, un nuevo repositorio de Git almacena los archivos, imágenes, datos adjuntos y secuencias de páginas de Markdown. Esta wiki admite la edición colaborativa de su contenido y estructura.

Las siguientes características son compatibles con la wiki del proyecto de equipo.

Aprovisionamiento o creación de una wiki

Trabajar con contenido wiki

Nota:

Es posible que la característica de impresión no esté disponible en el explorador web firefox.

Dar formato al contenido wiki

Publicación de repositorios git existentes en una wiki

Muchos equipos documentan su código mediante Markdown y comprueban estos archivos junto con el código. Aunque Git admite el mantenimiento y la revisión de dicha documentación junto con las solicitudes de incorporación de cambios estándar, estos archivos presentan algunos desafíos para los consumidores del contenido.

  • Los lectores a menudo deben examinar muchos archivos y carpetas para encontrar el contenido de interés.
  • El contenido carece de organización y estructura. No hay ninguna jerarquía de página inherente para admitir lectores.
  • No se admite el control de versiones de contenido.
  • La búsqueda a través del contenido se basa en la búsqueda de códigos en lugar de en una experiencia de búsqueda optimizada para buscar contenido.

Con el código de publicación como una característica wiki, puede publicar uno o varios repositorios de Git definidos en el proyecto de equipo en una wiki. Esta característica proporciona una manera de mantener el contenido junto con la base de código y le permite publicar y actualizar de forma selectiva el contenido a una wiki.

Hay diferencias significativas entre la forma de administrar el contenido de una wiki que se aprovisiona para un proyecto de equipo frente a las páginas wiki que publica desde un repositorio de Git. Para obtener más información, consulte Publicación de un repositorio de Git en una wiki.

Markdown

Markdown facilita el formato de texto e incluye imágenes. También puede vincular a documentos dentro de las páginas del proyecto, archivos LÉAME, paneles y solicitudes de incorporación de cambios. Puede proporcionar instrucciones al equipo en los siguientes lugares mediante Markdown:

Para ver la sintaxis admitida, consulte Uso de Markdown en Azure DevOps.

Archivos Léeme

Puede definir un archivo LÉAME o varios archivos para cada repositorio o proyecto de equipo. Escriba el ARCHIVO LÉAME en Markdown en lugar de texto sin formato.

Use páginas LÉAME para orientar a los colaboradores para que trabajen en el proyecto. Considere la posibilidad de agregar las instrucciones siguientes:

  • Enfoque del proyecto
  • Requisitos previos
  • Configuración del entorno
  • Recomendaciones para hacer cosas dentro del proyecto
  • Propósito o uso de archivos específicos
  • Términos y acrónimos específicos del proyecto
  • Guía de flujo de trabajo sobre cómo confirmar o cargar cambios y agregar ramas
  • Patrocinadores o contactos del proyecto

Estos son algunos grandes LÉXOS que usan este formato y hablan a todas las audiencias para obtener referencia e inspiración: