Escribir documentación

[Traducción Beta No Oficial]

Esta página fue traducida por PageTurner AI (beta). No está respaldada oficialmente por el proyecto. ¿Encontraste un error? Reportar problema →

Este documento contiene directrices para contribuir con cambios al sitio de documentación de Ent.

El sitio de documentación de Ent se genera desde el repositorio principal en GitHub.

Sigue esta breve guía para contribuir con mejoras y añadidos a la documentación:

Configuración inicial

1. Haz un fork y clona localmente el repositorio principal.

2. El sitio de documentación usa Docusaurus. Para ejecutarlo necesitarás tener Node.js instalado.

3. Instala las dependencias:

cd doc/website && npm install

4. Ejecuta el sitio en modo desarrollo:

cd doc/website && npm start

5. Abre tu navegador en http://localhost:3000.

Directrices generales

• Los archivos de documentación están en doc/md, con formato Markdown y anotaciones estilo "front-matter" al inicio. Más información sobre el formato de documentos de Docusaurus.

• Ent usa formatos Golang CommitMessage para mantener el historial del repositorio claro y legible. Por tanto, usa mensajes de commit como:

doc/md: adding a guide on contribution of docs to ent

Añadir nuevos documentos

1. Añade un nuevo archivo Markdown en el directorio doc/md, por ejemplo doc/md/writing-docs.md.

2. El archivo debe tener el siguiente formato:

---
id: writing-docs
title: Writing Docs
---
...

Donde id debe ser un identificador único para el documento, igual al nombre del archivo sin la extensión .md, y title es el título del documento como aparecerá en la página y elementos de navegación del sitio.

3. Si quieres que la página aparezca en la barra lateral del sitio de documentación, añade su id a website/sidebars.js, por ejemplo:

{
      type: 'category',
      label: 'Misc',
      items: [
        'templates',
        'graphql',
        'sql-integration',
        'testing',
        'faq',
        'generating-ent-schemas',
        'feature-flags',
        'translations',
        'contributors',
+       'writing-docs',
        'slack'
      ],
      collapsed: false,
    },