Saltar al contenido principal

Cómo añadir una cuenta a la Wiki

Para documentar una nueva cuenta AWS en esta Wiki, sigue estos pasos.

1. Crear el archivo .mdx​

Crea un nuevo archivo en docs/proyectos/ con el nombre de la cuenta en minúsculas y sin espacios (por ejemplo: mi-proyecto.mdx).

2. Frontmatter obligatorio​

Incluye al menos estos campos en el frontmatter (al inicio del archivo, entre ---):

---
title: Nombre visible de la cuenta
accountId: "123456789012"
description: Breve descripción del proyecto y uso de la cuenta.
status: complete   # complete | wip (por defecto: pendiente)
hide_title: true
sidebar_position: 10
---
  • title: Nombre que se verá en el sidebar y en la página.
  • accountId: ID de la cuenta AWS (entre comillas).
  • description: Una línea descriptiva.
  • status: complete (documentado), wip (en proceso) o omítelo para "Pendiente". Afecta al badge en la página de inicio.
  • hide_title: Si quieres ocultar el H1 automático y usar el tuyo.
  • sidebar_position: Orden en el menú lateral (menor número = más arriba).

3. Contenido​

Debajo del frontmatter, escribe el contenido en Markdown/MDX. Puedes usar tablas, bloques de código, Mermaid, etc., siguiendo el estilo de las cuentas existentes (por ejemplo docs/proyectos/asisa.mdx).

4. Sincronizar el badge en Inicio (opcional)​

Para que el badge de estado ("Documentado", "En proceso", "Pendiente") se muestre correctamente en la tarjeta de la Home, añade la entrada correspondiente en src/data/docStatus.ts:

export const docStatus: Record<string, 'complete' | 'wip'> = {
  asisa: 'complete',
  'mi-proyecto': 'wip',  // slug = nombre del archivo sin .mdx
};

El slug es el nombre del archivo sin la extensión (ej. mi-proyecto.mdx → mi-proyecto).

Si tienes dudas, revisa una cuenta ya creada como Asisa y replica su estructura.

Última actualización en