Écrire votre premier tutoriel pour la communauté

Cet espace est dédié aux utilisateurs d'Earth Engine qui souhaitent partager leurs connaissances avec le reste de la communauté Earth Engine. Créés par des utilisateurs d'Earth Engine pour des utilisateurs d'Earth Engine, les tutoriels de cette section s'adressent à tous les niveaux, des débutants aux utilisateurs plus avancés.

Les tutoriels peuvent être envoyés sous forme de texte brut et de code mis en forme à l'aide du langage de balisage Markdown, ou sous forme de notebooks Colab contenant du code Markdown et Python exécutable. Les tutoriels créés à l'aide des bibliothèques clientes JavaScript Earth Engine sont généralement rédigés en Markdown, tandis que Colab est recommandé pour les tutoriels basés sur les bibliothèques clientes Python Earth Engine.

Avant de commencer

Code de conduite

L'équipe Earth Engine s'engage à favoriser une communauté inclusive et sans harcèlement. Veuillez vous familiariser avec notre code de conduite avant de contribuer.

Rejoindre GitHub

Les tutoriels de la communauté Earth Engine sont partagés et examinés sur GitHub. Si vous n'avez pas encore de compte GitHub, vous devez d'abord en créer un sur https://github.com/join.

Proposer un tutoriel

Avant de consacrer beaucoup de temps et d'efforts à un nouveau tutoriel, les contributeurs potentiels sont invités à envoyer une proposition simple contenant quelques informations de base. Les auteurs peuvent ainsi collaborer avec les responsables de la documentation pour les développeurs Earth Engine afin de concentrer leurs efforts sur les tutoriels qui apportent le plus de valeur à la communauté des utilisateurs Earth Engine. Cela permet également de gagner du temps en évitant d'éventuels échanges pendant le processus d'examen.

Proposer un tutoriel

Configuration initiale

Si c'est la première fois que vous envoyez un tutoriel au dépôt GitHub de la communauté Earth Engine, veillez à suivre ces étapes avant de commencer à travailler sur votre tutoriel :

  1. Acceptez le Contributor License Agreement (CLA) à l'adresse suivante :

    https://cla.developers.google.com

  2. Lisez et assimilez le Guide de style des tutoriels de la communauté.

Rédiger et envoyer un tutoriel

Une fois votre proposition de tutoriel acceptée par les responsables, plusieurs options s'offrent à vous pour modifier le tutoriel et l'envoyer au dépôt de la communauté Earth Engine :

Démarrage rapide avec Markdown

Vous pouvez forker le dépôt GitHub et créer un tutoriel directement sur le site Web GitHub pour commencer rapidement sans outils ni configuration supplémentaires :

  1. Si ce n'est pas déjà fait, connectez-vous à GitHub.

  2. Pour créer et modifier un fichier de tutoriel, cliquez sur Nouveau tutoriel. Si nécessaire, vous serez invité à dupliquer le dépôt.

    Nouveau tutoriel

  3. Saisissez un nom pour le fichier tutoriel du formulaire :

    your-tutorial-name/index.md

    où your-tutorial-name est le nom abrégé de votre tutoriel en minuscules. Utilisez des tirets ("-") pour séparer les mots. N'utilisez pas d'espaces ni de signes de ponctuation dans le nom du dossier.

  4. Modifiez votre tutoriel directement dans l'éditeur de fichiers GitHub, en utilisant "Prévisualiser" pour vérifier la sortie mise en forme (voir aussi Modifier des fichiers dans votre dépôt dans la documentation GitHub).

  5. Lorsque vous êtes prêt, validez vos modifications et ouvrez une demande d'extraction.

Notebook Colab

Cliquez ici pour commencer à rédiger un tutoriel dans Colab :

Nouveau tutoriel Colab

Un notebook contenant des instructions pour créer et envoyer votre tutoriel s'ouvre.

Avancé

Si vous connaissez déjà GitHub, git et les outils associés, le processus global est le même pour envoyer des tutoriels Markdown et Colab :

  1. Dupliquez et clonez le dépôt GitHub google/earthengine-community.

  2. Créez un répertoire sous tutorials avec le nom court slugifié de votre tutoriel (par exemple, tutorials/my-amazing-tutorial).

  3. Ajoutez l'en-tête approprié pour Markdown ou Colab.

  4. Validez le tutoriel dans le nouveau répertoire avec le nom de fichier index.md (pour Markdown) ou tutorial.ipynb (pour Colab). Validez les images utilisées dans le tutoriel dans le même répertoire.

  5. Transférez le nouveau contenu vers votre fork et ouvrez une demande d'extraction.

Lorsque vous créez une demande d'extraction, veillez à faire référence à la proposition d'origine en indiquant son numéro de problème GitHub dans la section des commentaires. Par exemple, si le problème était le n° 123, vous devez placer le texte "Closes #123" dans la description de la demande d'extraction pour faire référence à la proposition d'origine et la marquer automatiquement comme terminée une fois le tutoriel publié.

Une fois votre demande de pull request ouverte, un ou plusieurs responsables seront chargés d'examiner votre envoi. Le ou les examinateurs travailleront avec vous pour s'assurer que votre envoi est complet, correct et conforme au Guide de style des tutoriels de la communauté Earth Engine.

Une fois votre demande d'extraction approuvée, votre tutoriel sera publié par les responsables du dépôt.