撰寫第一篇社群教學課程

這個空間專為 Earth Engine 使用者而設，方便他們與其他 Earth Engine 社群成員分享知識。本節的教學課程由 Earth Engine 使用者製作，適合所有程度的 Earth Engine 使用者，從初學者到進階使用者都能從中獲益。

提交教學課程時，可使用 Markdown 標記語言格式化純文字和程式碼，也可以提交內含 Markdown 和可執行 Python 程式碼的 Colab 筆記本。使用 Earth Engine JavaScript 用戶端程式庫建構的教學課程通常以 Markdown 格式編寫，而建議使用 Colab 進行以 Earth Engine Python 用戶端程式庫為基礎的教學課程。

事前準備

行為準則

Earth Engine 團隊致力於打造不受騷擾且多元包容的社群。請先詳閱行為準則，再做出貢獻。

加入 GitHub

Earth Engine 社群教學課程會透過 GitHub 分享及審查。如果您還沒有 GitHub 帳戶，請先前往 https://github.com/join 建立帳戶。

提議教學課程

在投入大量時間和心力製作新教學課程前，請先提交簡單的提案，並附上基本資訊。這樣一來，作者就能與 Earth Engine 開發人員文件維護者合作，專注於為 Earth Engine 使用者社群提供最有價值的教學課程。此外，您也能節省時間，避免在審查過程中來回溝通。

提議教學課程

首次設定

如果是首次將教學課程提交至 Earth Engine 社群 GitHub 存放區，請務必先完成下列步驟，再開始撰寫教學課程：

  1. 請前往下列網址接受《貢獻者授權協議》(CLA)：

    https://cla.developers.google.com

  2. 詳閱並熟記社群教學課程樣式指南。

撰寫及提交教學課程

維護人員接受教學課程提案後，您可以透過幾種方式編輯教學課程，並提交至 Earth Engine 社群存放區：

Markdown 快速入門

您可以將 GitHub 存放區分叉，並直接透過 GitHub 網站建立新的教學課程，快速上手，不需額外工具或設定：

  1. 如果尚未登入，請登入 GitHub。

  2. 如要建立及編輯新的教學課程檔案，請按一下「新增教學課程」。 系統會視需要提示您分叉存放區。

    新教學課程

  3. 輸入表單的教學課程檔案名稱：

    your-tutorial-name/index.md

    其中 your-tutorial-name 是教學課程的簡稱，且必須為全小寫。使用破折號 (「-」) 分隔字詞。資料夾名稱請勿使用空格或任何其他標點符號。

  4. 直接在 GitHub 檔案編輯器中編輯教學課程，並使用「預覽」驗證格式化輸出內容 (另請參閱 GitHub 說明文件中的「在存放區中編輯檔案」)。

  5. 準備就緒後，請提交變更並開啟提取要求。

Colab 筆記本

按這裡開始在 Colab 中撰寫教學課程：

全新 Colab 教學課程

系統會開啟筆記本，內含撰寫及提交教學課程的操作說明。

進階

如果您已熟悉 GitHub、Git 和相關工具，提交 Markdown 和 Colab 教學課程的整體流程相同：

  1. 建立 google/earthengine-community GitHub 存放區分支並加以複製。

  2. 在 tutorials 下建立目錄，並使用教學課程的 Slugified 簡稱 (例如 tutorials/my-amazing-tutorial)。

  3. 為 Markdown 或 Colab 新增適當的標頭。

  4. 將教學課程提交至新目錄，並將檔案命名為 index.md (適用於 Markdown) 或 tutorial.ipynb (適用於 Colab)。將本教學課程中使用的圖片提交至相同目錄。

  5. 將新內容推送至你的 Fork，然後開啟提取要求。

建立提取要求時，請務必在留言區中，以 GitHub 問題編號參照原始提案。舉例來說，如果問題是 #123，您可以在提取要求說明中加入「Closes #123」文字，參照原始提案，並在發布教學課程後自動將其標示為完成。

開啟提取要求後，系統會指派一或多位維護人員審查您的提交內容。審查人員會與您合作，確保提交內容完整無誤，並符合 Earth Engine 社群教學課程樣式指南。

提取要求獲得核准後，存放區維護人員就會發布您的教學課程。