Menulis tutorial komunitas pertama Anda

Ruang ini dikhususkan untuk pengguna Earth Engine yang ingin berbagi pengetahuan dengan komunitas Earth Engine lainnya. Dibuat oleh pengguna Earth Engine, untuk pengguna Earth Engine, tutorial di bagian ini ditujukan untuk semua level, dari pengguna pemula hingga pengguna yang lebih mahir.

Tutorial dapat dikirimkan sebagai teks biasa dan kode yang diformat menggunakan bahasa markup Markdown, atau sebagai notebook Colab yang berisi Markdown dan kode Python yang dapat dieksekusi. Tutorial yang dibuat menggunakan library klien JavaScript Earth Engine umumnya ditulis dalam Markdown, sedangkan Colab direkomendasikan untuk tutorial yang didasarkan pada library klien Python Earth Engine.

Sebelum memulai

Kode Etik

Tim Earth Engine berkomitmen untuk mendorong komunitas yang inklusif dan bebas pelecehan. Pelajari Kode Etik kami sebelum berkontribusi.

Bergabung dengan GitHub

Tutorial komunitas Earth Engine dibagikan dan ditinjau melalui GitHub. Jika belum memiliki akun GitHub, Anda harus membuatnya terlebih dahulu di https://github.com/join.

Mengajukan tutorial

Sebelum menginvestasikan waktu dan upaya yang signifikan untuk tutorial baru, calon kontributor diminta untuk mengirimkan proposal sederhana dengan beberapa informasi dasar. Hal ini memungkinkan penulis bekerja sama dengan pengelola dokumentasi developer Earth Engine untuk memfokuskan upaya pada tutorial yang memberikan nilai paling besar bagi komunitas pengguna Earth Engine. Tindakan ini juga menghemat waktu dengan menghindari potensi bolak-balik selama proses peninjauan.

Mengajukan tutorial

Penyiapan pertama

Jika ini pertama kalinya Anda mengirimkan tutorial ke repositori GitHub komunitas Earth Engine, pastikan untuk menyelesaikan langkah-langkah berikut sebelum memulai pekerjaan di tutorial Anda:

  1. Setujui Perjanjian Lisensi Kontributor (CLA) di:

    https://cla.developers.google.com

  2. Baca dan pahami Panduan Gaya Tutorial Komunitas.

Menulis dan mengirimkan tutorial

Setelah proposal tutorial Anda diterima oleh pengelola, ada beberapa opsi untuk mengedit tutorial dan mengirimkannya ke repositori komunitas Earth Engine:

Mulai cepat Markdown

Anda dapat membuat fork repositori GitHub dan membuat tutorial baru langsung melalui situs GitHub untuk memulai dengan cepat tanpa alat atau penyiapan tambahan:

  1. Jika belum, login ke GitHub.

  2. Untuk membuat dan mengedit file tutorial baru, klik New tutorial. Anda akan diminta untuk membuat fork repositori, jika diperlukan.

    Tutorial baru

  3. Masukkan nama untuk file tutorial dalam bentuk:

    your-tutorial-name/index.md

    Dengan your-tutorial-name adalah nama singkat tutorial Anda dalam huruf kecil semua. Gunakan tanda hubung ("-") untuk memisahkan kata. Jangan gunakan spasi atau tanda baca lainnya dalam nama folder.

  4. Edit tutorial Anda langsung di editor file GitHub, menggunakan "Preview" untuk memverifikasi output yang diformat (lihat juga Mengedit file di repositori Anda dalam dokumentasi GitHub).

  5. Setelah siap, lakukan commit perubahan dan buka permintaan pull.

Notebook Colab

Klik di sini untuk mulai menulis tutorial di Colab:

Tutorial Colab baru

Tindakan ini akan membuka notebook yang berisi petunjuk untuk menulis dan mengirimkan tutorial Anda.

Lanjutan

Jika Anda sudah memahami GitHub, git, dan alat terkait, proses keseluruhan sama untuk mengirimkan tutorial Markdown dan Colab:

  1. Buat fork dan clone repositori GitHub google/earthengine-community.

  2. Buat direktori di bawah tutorials dengan nama singkat tutorial Anda yang di-slug (misalnya, tutorials/my-amazing-tutorial).

  3. Tambahkan header yang sesuai untuk Markdown atau Colab.

  4. Lakukan commit tutorial ke direktori baru dengan nama file index.md (untuk Markdown) atau tutorial.ipynb (untuk Colab). Lakukan commit gambar yang digunakan dalam tutorial ke direktori yang sama.

  5. Kirim konten baru ke fork Anda dan buka permintaan pull request.

Saat membuat permintaan pull, pastikan untuk merujuk ke proposal asli berdasarkan nomor masalah GitHub di bagian komentar. Misalnya, jika masalahnya adalah #123, Anda akan menempatkan teks "Closes #123" dalam deskripsi permintaan pull untuk merujuk ke proposal asli, dan untuk otomatis menandainya sebagai selesai setelah tutorial dipublikasikan.

Setelah Anda membuka permintaan pull, satu atau beberapa pengelola akan ditetapkan untuk meninjau pengiriman Anda. Peninjau akan bekerja sama dengan Anda untuk memastikan pengiriman Anda lengkap, benar, dan konsisten dengan Panduan Gaya Tutorial Komunitas Earth Engine.

Setelah permintaan pull Anda disetujui, tutorial Anda akan dipublikasikan oleh pengelola repositori.