Este espacio está dedicado a los usuarios de Earth Engine que desean compartir sus conocimientos con el resto de la comunidad de Earth Engine. Creados por usuarios de Earth Engine para usuarios de Earth Engine, los instructivos de esta sección están destinados a todos los niveles, desde principiantes hasta usuarios más avanzados.
Los instructivos se pueden enviar como texto sin formato y código con formato con el lenguaje de marcado Markdown, o como notebooks de Colab que contienen Markdown y código Python ejecutable. Los instructivos creados con las bibliotecas cliente de JavaScript de Earth Engine suelen escribirse en Markdown, mientras que se recomienda Colab para los instructivos basados en las bibliotecas cliente de Python de Earth Engine.
Antes de comenzar
Código de conducta
El equipo de Earth Engine se compromete a fomentar una comunidad inclusiva y sin acoso. Familiarízate con nuestro Código de conducta antes de contribuir.
Cómo unirse a GitHub
Los instructivos de la comunidad de Earth Engine se comparten y revisan a través de GitHub. Si aún no tienes una cuenta de GitHub, primero debes crear una en https://github.com/join.
Cómo proponer un instructivo
Antes de invertir una cantidad significativa de tiempo y esfuerzo en un instructivo nuevo, se les pide a los posibles colaboradores que envíen una propuesta simple con información básica. Esto permite que los autores trabajen con los mantenedores de la documentación para desarrolladores de Earth Engine para centrar los esfuerzos en los instructivos que brindan el mayor valor a la comunidad de usuarios de Earth Engine. También ahorra tiempo, ya que evita posibles idas y vueltas durante el proceso de revisión.
Primera configuración
Si es la primera vez que envías un instructivo al repositorio de GitHub de la comunidad de Earth Engine, asegúrate de completar estos pasos antes de comenzar a trabajar en él:
Acepta el Acuerdo de licencia para colaboradores (CLA) en:
https://cla.developers.google.com
Lee y asimila la Guía de estilo de instructivos de la comunidad.
Cómo escribir y enviar un instructivo
Una vez que los mantenedores acepten tu propuesta de instructivo, tendrás varias opciones para editarlo y enviarlo al repositorio de la comunidad de Earth Engine:
Inicio rápido de Markdown
Puedes bifurcar el repositorio de GitHub y crear un instructivo nuevo directamente a través de el sitio web de GitHub para comenzar rápidamente sin herramientas ni configuración adicionales:
Si aún no lo hiciste, accede a GitHub.
Para crear y editar un archivo de instructivo nuevo, haz clic en Nuevo instructivo. Se te solicitará que bifurques el repositorio, si es necesario.
Ingresa un nombre para el archivo de instructivo con el siguiente formato:
your-tutorial-name/index.mdDonde
your-tutorial-namees el nombre corto de tu instructivo en minúsculas. Usa guiones ("-") para separar palabras. No uses espacios ni ningún otro signo de puntuación en el nombre de la carpeta.Edita tu instructivo directamente en el editor de archivos de GitHub con "Vista previa" para verificar el resultado con formato (consulta también Edición de archivos en tu repositorio en la documentación de GitHub).
Cuando esté todo listo, confirma los cambios y abre una solicitud de extracción.
Notebook de Colab
Haz clic aquí para comenzar a escribir un instructivo en Colab:
Se abrirá un notebook con instrucciones para crear y enviar tu instructivo.
Avanzado
Si ya estás familiarizado con GitHub, git y las herramientas relacionadas, el proceso general es el mismo para enviar instructivos de Markdown y Colab instructivos:
Bifurca y clona el repositorio de GitHub google/earthengine-community.
Crea un directorio en
tutorialscon el nombre corto slugificado de tu instructivo (p.ej.,tutorials/my-amazing-tutorial).Confirma el instructivo en el directorio nuevo con el nombre de archivo
index.md(para Markdown) otutorial.ipynb(para Colab). Confirma las imágenes que se usan en el instructivo en el mismo directorio.Envía el contenido nuevo a tu bifurcación y abre una solicitud de extracción.
Cuando crees una solicitud de extracción, asegúrate de hacer referencia a la propuesta original por su número de problema de GitHub en la sección de comentarios. Por ejemplo, si el problema era el n.° 123, colocarías el texto "Closes #123" en la descripción de la solicitud de extracción para hacer referencia a la propuesta original y marcarla automáticamente como completada una vez que se publique el instructivo.
Una vez que abras una solicitud de extracción, se asignará uno o más mantenedores para revisar tu envío. Los revisores trabajarán contigo para garantizar que tu envío esté completo, sea correcto y coherente con la Guía de estilo de instructivos de la comunidad de Earth Engine.
Una vez que se apruebe tu solicitud de extracción, los mantenedores del repositorio publicarán tu instructivo.