Escribir Documentación

Para crear o modificar una entrada de la documentación, se debe clonar el repositorio de Git correspondiente a la página de documentación.

A continuación, se debe crear un archivo .md o .mdx en la carpeta src/content/docs, dentro de una de las categorías. Por ejemplo, esta página de la documentación corresponde al archivo src/content/docs/Otros/escribir_documentación.md.

El archivo debe comenzar con un encabezado en formato YAML. El encabezado debe ser lo primero que aparece en el archivo y estar encerrado entre dos líneas que contengan --- únicamente.

La estructura del encabezado es la siguiente:

---
title: Escribir Documentación
tableOfContents:
  maxHeadingLevel: 4
sidebar:
  order: 1
---

La propiedad title contiene el título que aparecerá en la barra de navegación a la izquierda de la página.

La propiedad maxHeadingLevel hará que los títulos de hasta nivel 4 sean incluidos en la tabla de contenidos a la derecha de la página. Se recomienda no cambiar este valor.

La propiedad order representa el orden en que aparecen distintas páginas pertenecientes a la misma categoría en la barrad de navegación. Se puede dejar en 1. Cuando varias páginas tienen el mismo valor, se ordenan alfabéticamente.

Posterior al encabezado, se escriben los contenidos de la página de documentación en formato Markdown.

Cuando la entrada esté terminada, se debe realizar un commit con los cambios y subirlos al repositorio remoto. La página se actualizará en unos minutos.

Ejemplo

El presente archivo se ve de la siguiente forma:

---
title: Escribir Documentación
tableOfContents:
  maxHeadingLevel: 4
sidebar:
  order: 1
---

Para crear o modificar una entrada de la documentación, se debe
[clonar](/ingenieria/git/comandos_git/#comandos) el repositorio de
[Git](https://git-scm.com/) correspondiente a la página de documentación.

A continuación, se debe crear un archivo `.md` o `.mdx` en la carpeta
`src/content/docs`, dentro de una de las categorías. Por ejemplo, esta página de
la documentación corresponde al archivo
`src/content/docs/Otros/escribir_documentación.md`.

El archivo debe comenzar con un encabezado en formato
[YAML](https://www.redhat.com/es/topics/automation/what-is-yaml). El encabezado
debe ser lo primero que aparece en el archivo y estar encerrado entre dos líneas
que contengan `---` únicamente.

La estructura del encabezado es la siguiente:

```yaml
---
title: Escribir Documentación
tableOfContents:
  maxHeadingLevel: 4
sidebar:
  order: 1
---
```

La propiedad `title` contiene el título que aparecerá en la barra de navegación
a la izquierda de la página.

La propiedad `maxHeadingLevel` hará que los títulos de hasta nivel 4 sean
incluidos en la tabla de contenidos a la derecha de la página. Se recomienda no
cambiar este valor.

La propiedad `order` representa el orden en que aparecen distintas páginas
pertenecientes a la misma categoría en la barrad de navegación. Se puede dejar
en `1`. Cuando varias páginas tienen el mismo valor, se ordenan alfabéticamente.

Posterior al encabezado, se escriben los contenidos de la página de
documentación en formato
[Markdown](https://www.markdownlang.com/es/intro/what-is-markdown.html).

Cuando la entrada esté terminada, se debe realizar un
[commit](/ingenieria/git/flujos/) con los cambios y subirlos al repositorio
remoto. La página se actualizará en unos minutos.