• Español
  • Cómo contribuir al portal

    Esta guía cubre el flujo completo para agregar o editar una página del portal: decidir dónde vive, escribirla en español y en inglés, y validarla antes del MR.

    Requisitos previos

    • Acceso al repo crehana-team/platform/engineering-docs
    • Node.js 20 o superior
    • pnpm (el repo usa pnpm; no agregues otro gestor de paquetes)

    Instala las dependencias una vez:

    pnpm install

    Decide dónde va tu página

    La regla en una frase: si tu contenido trata de un solo repo, vive en ese repo; si trata de cómo trabajamos todos, vive aquí, agrupado por género.

    Tu contenidoDónde va
    Explica algo que usan varios equipos: autenticación, GraphQL, uploads, CDNdocs/<locale>/guides/ en este repo
    Define una norma o un criterio común: code review, testing, convencionesdocs/<locale>/standards/ en este repo
    Describe un solo repo: runbook, setup, contrato de su APILa carpeta docs/ de ese repo
    Es contenido de producto o de negocioConfluence

    Tres reglas sostienen esa tabla:

    1. El género manda en el primer nivel. Las secciones son guides/, standards/ y repos/. Nunca un equipo ni un área del organigrama: los equipos se renombran y las URLs se rompen.
    2. La disciplina es una hoja, no una raíz. Backend, frontend, QA e infra aparecen debajo de un tema: standards/code-review/backend, nunca backend/code-review.
    3. Primero compartido, dividir después. Escribe una sola página por tema. Divídela por disciplina cuando el contenido diverja de verdad, no antes. La URL del tema no cambia en ninguno de los dos casos.

    Escribe la página en ambos idiomas

    El portal sirve español en las URLs sin prefijo y inglés bajo /en/. Los slugs son idénticos en ambos idiomas: siempre en inglés, ASCII y kebab-case.

    1. Crea la página en español:

      docs/es/guides/cdn/index.md
    2. Crea su contraparte en inglés, con el mismo slug:

      docs/en/guides/cdn/index.md
    3. Escribe el cuerpo en español LATAM con los términos técnicos en inglés: «el pipeline», «hacer deploy», «el merge request». La página en inglés es una traducción completa.

    4. Elige un solo tipo de página y no lo mezcles. Las plantillas están en plantillas de página.

    El build falla cuando una página existe en un idioma y no en el otro, e indica el archivo que falta. Las páginas agregadas desde otros repos están exentas: se sirven tal como las escribió su repo de origen.

    Valida antes del MR

    pnpm run build

    Deberías ver las tres validaciones en verde antes de que Rspress compile:

    ✓ catalog: 2 repos, 0 registered for aggregation
    ✓ i18n parity: 8 page(s) present in es + en
    ✓ provenance: 0 aggregated page(s) traced to a source

    Un build roto significa un enlace muerto, un frontmatter inválido o una página sin contraparte. Arréglalo antes de pedir revisión.

    Para ver el portal mientras escribes:

    pnpm run dev

    Abre el MR

    Aprueba el equipo dueño del tema. Un MR que agrega una guía transversal necesita la aprobación de los equipos que la van a usar, no solo de quien la escribió.

    Solución de problemas

    SíntomaCausaSolución
    ✖ i18n parity: 1 page(s) exist in one locale onlyEscribiste la página en un solo idiomaCrea el archivo que el mensaje indica
    Dead link foundUn enlace apunta a una página que no existeCorrige la ruta; los enlaces se escriben sin el prefijo de idioma
    ✖ provenance: ...Una página bajo repos/ perdió su procedenciaVuelve a correr pnpm run aggregate

    Relacionado