Este repositorio contiene el contenido para la Documentación del Desarrollador de Avalanche desplegada en https://docs.avax.network.
El sitio está construido usando Docusaurus 2.
¡Contribuir al sitio de documentación es una excelente manera de involucrarse con la comunidad de desarrollo de Avalanche! Así es cómo empezar:
Para pequeños errores tipográficos o correcciones, es fácil contribuir sin necesidad de clonar/bifurcar el repositorio. Simplemente:
- Desplázate hasta el final de la página y haz clic en "Editar esta página"
- Hacer un fork del repositorio
- Anotar la ruta en la parte superior de la página
(por ejemplo:
avalanche-docs/docs/learn/avalanche/intro.md) - Hacer clic en "Cancel changes"
- Navegar a la ruta de la página en español
(
avalanche-docs/i18n/es/docusaurus-plugin-content-docs/current/learn/avalanche/intro.md) - Hacer clic en "Edit this file"
- Realiza los cambios en la página directamente en la interfaz gráfica de Github
- Haz clic en "Commit changes ..."
- Edita el
commit messagepara describir el cambio en 4 palabras o menos, e incluye cualquier detalle adicional en la descripción - Haz clic en "Sign off and commit changes" para crear una solicitud de extracción con tus cambios propuestos
Para proponer nueva documentación o ediciones grandes a nuestras páginas existentes, sigue los pasos correspondientes:
- Miembros de la Organización de Github de Ava Labs: Clona el repositorio
git clone https://github.com/ava-labs/avalanche-docs.git - Contribuidores Externos: Bifurca el repositorio a través de la interfaz gráfica de GitHub
- Haz checkout a una nueva rama
git checkout -b <tu-nombre/nombre-de-la-rama> - Realiza los cambios en tu rama
git add .yarn buildpara asegurarte de que la construcción pasegit commit -m "mensaje de confirmación"git push- Ve a GitHub y abre una nueva solicitud de extracción
- La documentación se encuentra en el directorio
i18n/es/docusaurus-plugin-content-docs/current/.
La ruta de un documento corresponde
con su extensión de dominio. Por ejemplo: la guía que muestra cómo
Ejecutar un Nodo Avalanche Manualmente
se encuentra en este repositorio en
i18n/es/docusaurus-plugin-content-docs/current/nodes/run/node-manually.md, y está alojada en https://docs.avax.network/es/nodes/run/node-manually. Si un archivo no existe en este camino de archivos, entonces por defecto se mostrará el archivo en inglés ubicado en el camino de archivos docs. - La barra lateral izquierda de la página está controlada principalmente por
sidebars.json, donde las subsecciones a veces se ordenan por su
campo de metadatos
sidebar_position. - Nuestra guía de estilo se puede encontrar aquí.
- Este repositorio utiliza una serie de herramientas de verificación de estilo, linting y formateo. Consulta style-checker-notes.md para más detalles y cómo corregir los errores.
- Todos los archivos de imagen deben incluirse en static/img/.
- La documentación extensa de Docusaurus se puede encontrar aquí.
- Todas las PR deben hacerse contra la rama
master. - Después de una construcción exitosa, Cloudflare Pages comentará en la PR con un enlace a *.avalanche-docs.pages.dev donde puedes verificar tus cambios.
- Una vez que tu PR se haya fusionado en
master, https://docs.avax.network/ se actualizará con tus cambios.
yarnyarn startEste comando inicia un servidor de desarrollo local y abre una ventana del navegador. La mayoría de los cambios se reflejan en vivo sin tener que reiniciar el servidor.
yarn buildEste comando genera contenido estático en el directorio build y puede ser servido utilizando cualquier servicio de alojamiento de contenido estático.
Por favor, asegúrate de ejecutar este comando para ver si hay algún error en la construcción del paquete, y arréglalos antes de empujar tus cambios.
La búsqueda está alimentada por Algolia y el archivo de configuración se encuentra aquí.
La información que estoy solicitando está relacionada con un proyecto específico, es decir, AvalancheGo, AvalancheNetworkRunner, etc.:
- Por favor, levanta un Issue de Documentación Faltante en el repositorio de GitHub de ese proyecto y detalla minuciosamente tu solicitud. Incluye referencias a cualquier página existente relevante para tu solicitud.
La información que estoy solicitando es de naturaleza explicativa y actualmente no existe:
- Por favor, abre un nuevo Issue en este repositorio y detalla minuciosamente tu solicitud de acuerdo con la plantilla del issue. Si es urgente, por favor crea un nuevo ticket en el Panel de Propuestas de Mejora de la Documentación de Desarrollo.
Información errónea o faltante en la documentación no relacionada con un proyecto específico necesita edición: