Acerca de wikis, LÉAME y Markdown
Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018- TFS 2015
Para admitir a su 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 dentro de una wiki de 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.
Para admitir a su 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 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, las imágenes, los datos adjuntos y la secuencia de páginas de Markdown. Esta wiki admite la edición colaborativa de su contenido y estructura.
Nota:
La wiki integrada está disponible con TFS 2018 y versiones posteriores. Para descargar Azure DevOps Server, consulte Visual Studio Descargas.
Las siguientes características son compatibles con la wiki del proyecto de equipo.
Aprovisionamiento o creación de una wiki
Trabajar con contenido wiki
- Adición y edición de páginas de wiki
- Ver el historial de páginas wiki y revertir
- Versión, selección o anular la publicación de una wiki publicada
- Clonación y actualización de contenido wiki sin conexión
- Uso de métodos abreviados de teclado wiki
- Filtrar o imprimir contenido wiki1
Nota:
Es posible que la característica de impresión no esté disponible en el explorador web Firefox.
Dar formato al contenido de wiki
Las siguientes características son compatibles con la wiki del proyecto de equipo que se crea en la versión de TFS indicada o en versiones posteriores. Para más información, consulte Creación de una wiki para el proyecto de equipo y Adición y edición de páginas wiki.
| Característica | Versión de TFS |
|---|---|
| Formato Markdown | TFS 2018 |
| Etiquetas HTML | TFS 2018 |
| Inserción y cambio de tamaño de imágenes | TFS 2018 |
| Vínculo a elementos de trabajo mediante # | TFS 2018 |
| Adjuntar archivos | TFS 2018 |
| Filtrado de LA TOC de Wiki | TFS 2018 |
| Notación matemática y caracteres | TFS 2018.2 |
| Vista previa de una página Wiki durante la edición | TFS 2018.2 |
| Imprimir una página Wiki1 | TFS 2018.2 |
| Métodos abreviados de teclado wiki | TFS 2018.2 |
Publicación de repositorios de 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 extracción estándar, estos archivos presentan algunos desafíos a los consumidores del contenido.
- A menudo, los lectores deben realizar una búsqueda a través de 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áginas 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 del código, en lugar de una experiencia de búsqueda optimizada para buscar contenido.
Con la característica publicar código como 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, pero publicar y actualizar de forma selectiva el contenido en una wiki.
Hay diferencias significativas entre cómo administrar el contenido de una wiki que se aprovisiona para un proyecto de equipo y las páginas wiki que se publican desde un repositorio de Git. Para más información, consulte Publicación de un repositorio de Git en una wiki.
Markdown
Markdown facilita el formato del texto e incluye imágenes. También puede vincular a documentos dentro de las páginas del proyecto, archivos LÉAME, paneles y comentarios de solicitud de extracción.
Puede proporcionar instrucciones a su equipo en los siguientes lugares mediante Markdown:
Para obtener una sintaxis compatible, consulte Guía de sintaxis para archivos Markdown, widgets, wikis y comentarios de solicitud de extracción.
READMEs
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 a trabajar en el proyecto. Considere la posibilidad de agregar las siguientes instrucciones:
- Project enfoque
- Prerrequisitos
- Configuración del entorno
- Sugerencias para realizar las cosas en el proyecto
- Propósito o uso de archivos específicos
- Project términos y acrónimos específicos
- Guía de flujo de trabajo sobre la confirmación o carga de cambios y la adición de ramas
- Project patrocinadores o contactos
Estas son algunas lecturas excelentes que usan este formato y hablan a todos los públicos, como referencia e inspiración: