Cómo contribuir

Este es un sitio de documentación vivo, lo que significa que necesitamos la ayuda de la comunidad para mantener y actualizar el contenido. Cualquier contribución, desde escribir secciones completas y traducciones hasta corregir errores ortográficos y gramaticales, será muy apreciada.

Utiliza esta invitación a GitBook para sugerir cambios y nuevo contenido directamente en GitBook:

Puedes ganar GitPOAPs contribuyendo directamente a la Base de conocimiento de EthStaker (contribuyente↗) y haciendo una pregunta que conduzca a la creación de contenido (colaborador↗).

Para sugerir cambios o agregar contenido nuevo, visita nuestro EthStaker Github↗ o si tienes alguna pregunta, únete a nuestro Discord↗

Crea una solicitud para cualquier cambio que quieras realizar y lo revisaremos lo antes posible.

• Notas sobre la estandarización de documentación

• Crear/Actualizar tablas de contenido

• Glosario y orden de encabezados en preguntas frecuentes

Notas sobre la estandarización de documentación

Utiliza estas notas cuando escribas para esta base de conocimientos para mantener un formato estandarizado.

• Utiliza enlaces relativos↗ para navegar entre diferentes archivos dentro de esta base de conocimiento.

• [Otro enlace a documento](otro_documento.md) → Otro enlace a documento

• Use enlaces de anclaje a encabezados dentro del mismo archivo.

  • [Enlace ancla](#encabezado-ancla) → Enlace Ancla

• Combina enlaces relativos a otros archivos con enlaces ancla.

  • [Enlace ancla a otro documento](otro_documento.md#encabezado-ancla) → Enlace ancla a otro documento

• Muestra cuando un enlace hace referencia a un sitio externo agregando el icono ↗ al final del enlace.

  • [Enlace externo ↗](https://example.com) → Enlace externo ↗

• Crea una imagen que también sea un enlace.

  • [![image-text](https://some.site/your-image.jpg)](https://some.site/your-link.html)

Crear/Actualizar tablas de contenido

Las tablas de contenido se crean usando una extensión de VSCode Markdown All in One ↗ usando el comando Create Table of Contents (en el VS Code Command Palette ↗) para insertar una nueva tabla de contenido. Luego debería actualizarse automáticamente cuando se guarda un archivo.

Agrega la etiqueta <!-- omit in toc --> a cualquier encabezado que no quieras que se incluya en la Tabla de contenido.

# HEADING <!-- omit in toc -->

Glosario y orden de encabezados en preguntas frecuentes

Al agregar elementos al Glosario y Preguntas frecuentes, es importante que permanezcan en orden alfabético para que sea más fácil navegar. Como no existe una forma nativa de lograr esto en Markdown, se puede usar este script bash para reordenar los encabezados.

El nombre del archivo alphabetical-ordering.sh se ha agregado al archivo .gitignore.

touch alphabetical-ordering.sh
chmod 700 alphabetical-ordering.sh

Edita el nuevo archivo con tu editor de texto preferido.

#!/bin/bash
# Reorder glossary and store just the reordered content in a temp file
perl -0777 -ne '
    (undef,@paragraphs) = split /^##(?=[^##])/m;
    print map {"##$_"} sort @paragraphs;
' staking-glossary.md > staking-glossary-temp-1.md

# Delete everything after the first --- in and store in a temp file
sed '/---/q' staking-glossary.md > staking-glossary-temp-2.md

# Combine the two files
cat staking-glossary-temp-2.md > staking-glossary.md
cat staking-glossary-temp-1.md >> staking-glossary.md

# Delete the temp files
rm staking-glossary-temp-1.md
rm staking-glossary-temp-2.md


# Reorder FAQ and store just the reordered content in a temp file
perl -0777 -ne '
    (undef,@paragraphs) = split /^##(?=[^##])/m;
    print map {"##$_"} sort @paragraphs;
' faq.md > faq-temp-1.md

# Delete everything after the first --- and store in a temp file
sed '/---/q' faq.md > faq-temp-2.md

# Combine the two files
cat faq-temp-2.md > faq.md
cat faq-temp-1.md >> faq.md

# Delete the temp files
rm faq-temp-1.md
rm faq-temp-2.md

Ejecuta el script.

./alphabetical-ordering.sh

Esta fue una secuencia de comandos rápida, así que si tienes alguna mejora, ¡actualízalo aquí!