La modificación del archivo sidebar.yml, permite organizar la estructura de la tabla de contenido del proyecto/manual de acuerdo al orden lógico de uso de la funcionalidad.
Los campos que se deben organizar en el sidebar son title y chapter.
Cómo modificar el archivo _sidebar
1. Ingrese a la consola de Azure DevOps, en el menú principal seleccione la opción Repos (repositorio).
2. En el menú encabezado seleccione el repositorio del proyecto/manual en curso. Ejemplo aranda-docs.
⚐ Nota: Antes de modficar la la tabla de contenido en el sidebar, cree una rama para registrar los cambios. Ver creación de Ramas en un Proyecto
3. En la vista de información seleccione la carpeta _data y el archivo sidebar.yml; en la vista detalle del sydebar haga clic en Edit para organizar la tabla de contenido del manual que podrá visualizar el usuario final.
Los elementos como está estructurado el sidebar o tabla de contenido son los siguientes:
| Nombre | Descripción |
|---|---|
| chapter | Es la categoría principal que agrupa los artículos de un tema de la funcionalidad. |
| title | El es el nombre visible del capítulo que agrupa los artículos de un tema de la funcionalidad y se presentará en forma jerárquica en la tabla de contenido del manual. |
| Pages | Corresponde al nombre de los artículos de un tema específico de la funcionalidad y se relaciona la ruta dentro del repositorio donde se encuentra el artículo. Ejemplo: _pages/nombre_del_chapter/nombre_del_artículo.md |
⚐ Advertencia: El nombre del Chapter del artículo debe coincidir con el nombre del chapter relacionado en el sidebar; de esta forma la tabla de contenido estructurada en el sydebar podrá tener visible las categorías establecidas.
⚐ Nota: Los artículos relacionados en la estructura del sidebar pueden pertenecer a un solo chapter(capítulo) o a varios chapter.
Estructura básica del sidebar:
docs:
- chapter: "configuracion_repositorio"
title: Configurar Repositorio
pages:
- _pages/configuracion_repositorio/configurar_repositorio.md
- _pages/configuracion_repositorio/crear_repositorio.md
- _pages/configuracion_repositorio/clonar_repositorio.md
- _pages/configuracion_repositorio/estructurar_repositorio.md
- chapter: "estructurar_repositorio"
title: Estructurar Repositorio
pages:
- _pages/estructurar_repositorio/sidebar.md
- _pages/estructurar_repositorio/pages.md
- _pages/estructurar_repositorio/branding.md
- _pages/estructurar_repositorio/images.md
- _pages/estructurar_repositorio/config.md
Resultado de la estructura del sidebar:
La información ingresada en el sidebar debe tener en cuenta lo siguiente:
Recomendaciones:
- 1. Los nombres en Chapter, Title y Pages No debe tener espacios entre las palabras.
- 2. Los nombres en Chapter y Pages deben estar escritos en minúsculas.-
- 3. Los nombres del Title pueden estar escritos en minúscula/mayúscula y pueden llevar tildes
- 4. Para unir palabras se debe utilizar guion o raya al piso (- _).
- 5. No se deben incluir caracteres especiales, ni tildes.
4. Después de modificar el sydebar haga clic en Commit para actualizar los cambios.
5. Para implementar los ajustes en el proyecto, en la vista detalle del sydebar seleccione la opción Pull Request. Ver Crear Pull Request
👆 Importante
-
La definición y organización correcta del “Chapter”, posibilita la visualización de los contenidos en el menú de navegación. Si un concepto no tiene este chapter no será visible al momento de hacer la publicación.
-
Cada artículo dentro de la opción Pages, tiene referenciado en su encabezado el nombre del Título (Title) y en nombre del Capítulo (chapter) al que pertenecen.