初めてのコミュニティ チュートリアルを作成する

このスペースは、Earth Engine コミュニティの他のメンバーと知識を共有したい Earth Engine ユーザーのためのものです。このセクションのチュートリアルは、Earth Engine ユーザーが Earth Engine ユーザーのために作成したもので、初心者から上級者まで、あらゆるレベルのユーザーを対象としています。

チュートリアルは、マークダウン マークアップ言語を使用して書式設定された書式なしテキストとコードとして送信することも、マークダウンと実行可能な Python コードを含む Colab ノートブックとして送信することもできます。Earth Engine JavaScript クライアント ライブラリを使用して作成されたチュートリアルは通常マークダウンで記述されますが、Earth Engine Python クライアント ライブラリに基づくチュートリアルには Colab をおすすめします。

始める前に

行動規範

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 コミュニティ リポジトリに送信する方法がいくつかあります。

マークダウン クイックスタート

GitHub リポジトリをフォークして、 GitHub ウェブサイトから直接新しいチュートリアルを作成すると、追加のツールや 設定なしですぐに始めることができます。

  1. まだ GitHub にログインしていない場合は、ログインします

  2. 新しいチュートリアル ファイルを作成して編集するには、[新しいチュートリアル] をクリックします。 必要に応じて、リポジトリをフォークするように求められます。

    新しいチュートリアル

  3. 次の形式でチュートリアル ファイルの名前を入力します。

    your-tutorial-name/index.md

    ここで、your-tutorial-name はチュートリアルの略称で、すべて小文字です。単語を区切るにはダッシュ(-)を使用します。フォルダ名に スペースやその他の句読点を使用しないでください。

  4. GitHub ファイル エディタでチュートリアルを直接編集し、 [プレビュー] を使用して書式設定された出力を確認します(GitHub ドキュメントのリポジトリ内のファイルを編集するもご覧ください)。

  5. 準備ができたら、変更を commit して pull リクエストを開きます。

Colab ノートブック

Colab でチュートリアルの作成を開始するには、こちらをクリックしてください。

新しい Colab チュートリアル

チュートリアルの作成と 送信の手順が記載されたノートブックが開きます。

高精度

GitHub、git、関連ツールに精通している場合、 マークダウン チュートリアルと Colab チュートリアルの送信プロセスは同じです。

  1. google/earthengine-community GitHub リポジトリをフォークしてクローンを作成します。

  2. tutorials の下に、チュートリアルのスラッグ化された略称(例: tutorials/my-amazing-tutorial)でディレクトリを作成します。

  3. Markdown または Colab に適切なヘッダーを追加します。

  4. ファイル名 index.md (マークダウンの場合)または tutorial.ipynb(Colab の場合)で、チュートリアルを新しいディレクトリに commit します。チュートリアルで使用する画像を同じディレクトリに commit します。

  5. 新しいコンテンツをフォークに push して、pull リクエスト を開きます

pull リクエストを作成するときは、コメント セクションで GitHub の管理番号を使用して元の提案を参照してください。たとえば、課題が #123 の場合は、pull リクエストの説明に「Closes #123」というテキストを配置して元の提案を参照し、チュートリアルが公開されたら自動的に完了としてマークします。

pull リクエストを開くと、1 人以上のメンテナーが割り当てられて送信内容がレビューされます。レビュー担当者は、送信内容が完全で正確であり、Earth Engine コミュニティ チュートリアル スタイルガイドに準拠していることを確認します。

pull リクエストが承認されると、リポジトリのメンテナーによってチュートリアルが公開されます。