نوشتن اولین آموزش انجمن شما

این فضا به کاربران Earth Engine اختصاص داده شده است که می‌خواهند دانش خود را با بقیه جامعه Earth Engine به اشتراک بگذارند. آموزش‌های این بخش که توسط کاربران Earth Engine ایجاد شده است، برای کاربران Earth Engine در همه سطوح، از مبتدی تا پیشرفته‌تر، در نظر گرفته شده است.

آموزش‌ها می‌توانند به صورت متن ساده و کد قالب‌بندی شده با استفاده از زبان نشانه‌گذاری Markdown، یا به صورت دفترچه‌های Colab حاوی Markdown و کد پایتون قابل اجرا ارسال شوند. آموزش‌هایی که با استفاده از کتابخانه‌های کلاینت جاوا اسکریپت Earth Engine ساخته می‌شوند، عموماً به صورت Markdown نوشته می‌شوند، در حالی که Colab برای آموزش‌هایی که بر اساس کتابخانه‌های کلاینت پایتون Earth Engine ساخته شده‌اند، توصیه می‌شود.

قبل از اینکه شروع کنی

آیین‌نامه رفتاری

تیم Earth Engine متعهد به پرورش جامعه‌ای عاری از آزار و اذیت و فراگیر است. لطفاً قبل از مشارکت، با اصول اخلاقی ما آشنا شوید.

پیوستن به گیت‌هاب

آموزش‌های انجمن Earth Engine از طریق GitHub به اشتراک گذاشته و بررسی می‌شوند. اگر از قبل حساب GitHub ندارید، ابتدا باید از طریق https://github.com/join یکی ایجاد کنید.

پیشنهاد یک آموزش

قبل از صرف زمان و تلاش قابل توجه روی یک آموزش جدید، از مشارکت‌کنندگان بالقوه خواسته می‌شود تا یک پیشنهاد ساده با برخی اطلاعات اولیه ارائه دهند. این امر به نویسندگان اجازه می‌دهد تا با نگهدارندگان مستندات توسعه‌دهندگان Earth Engine همکاری کنند تا تلاش‌ها را روی آموزش‌هایی متمرکز کنند که بیشترین ارزش را برای جامعه کاربران Earth Engine فراهم می‌کنند. همچنین با جلوگیری از رفت و برگشت‌های احتمالی در طول فرآیند بررسی، در زمان صرفه‌جویی می‌شود.

پیشنهاد یک آموزش

راه‌اندازی برای اولین بار

اگر این اولین باری است که یک آموزش را به مخزن گیت‌هاب انجمن Earth Engine ارسال می‌کنید، حتماً قبل از شروع کار روی آموزش خود، این مراحل را انجام دهید:

  1. توافقنامه مجوز مشارکت‌کننده (CLA) را در آدرس زیر بپذیرید:

    https://cla.developers.google.com

  2. راهنمای سبک آموزش انجمن را بخوانید و درونی کنید.

نوشتن و ارسال آموزش

پس از اینکه پیشنهاد آموزشی شما توسط مسئولین پذیرفته شد، چندین گزینه برای ویرایش آموزش و ارسال آن به مخزن انجمن Earth Engine وجود دارد:

شروع سریع با Markdown

شما می‌توانید مخزن گیت‌هاب را فورک کنید و مستقیماً از طریق وب‌سایت گیت‌هاب یک آموزش جدید ایجاد کنید تا بدون ابزار یا تنظیمات اضافی، به سرعت شروع به کار کنید:

  1. اگر هنوز وارد نشده‌اید، وارد گیت‌هاب شوید .

  2. برای ایجاد و ویرایش یک فایل آموزشی جدید، روی «آموزش جدید» کلیک کنید. در صورت نیاز، از شما خواسته می‌شود که مخزن را فورک کنید.

    آموزش جدید

  3. نامی برای فایل آموزشی فرم وارد کنید:

    your-tutorial-name/index.md

    که در آن your-tutorial-name نام کوتاه آموزش شما با حروف کوچک است. از خط تیره ("-") برای جدا کردن کلمات استفاده کنید. از فاصله یا هیچ علامت نگارشی دیگری در نام پوشه استفاده نکنید.

  4. آموزش خود را مستقیماً در ویرایشگر فایل GitHub ویرایش کنید، با استفاده از «پیش‌نمایش» خروجی قالب‌بندی شده را تأیید کنید (همچنین به ویرایش فایل‌ها در مخزن خود در مستندات GitHub مراجعه کنید).

  5. پس از آماده شدن، تغییرات خود را اعمال کنید و یک درخواست pull باز کنید.

نوت بوک کولاب

برای شروع نوشتن یک آموزش در Colab اینجا کلیک کنید:

آموزش جدید Colab

این کار یک دفترچه یادداشت حاوی دستورالعمل‌های نوشتن و ارسال آموزش شما را باز می‌کند.

پیشرفته

اگر از قبل با GitHub، git و ابزارهای مرتبط آشنا هستید، روند کلی برای ارسال آموزش‌های Markdown و Colab یکسان است:

  1. مخزن گیت‌هاب google/earthengine-community را منشعب و کلون کنید.

  2. یک دایرکتوری در زیر tutorials با نام کوتاه و مختصر آموزش خود ایجاد کنید (مثلاً tutorials/my-amazing-tutorial ).

  3. سربرگ مناسب برای Markdown یا Colab را اضافه کنید.

  4. آموزش را در دایرکتوری جدید با نام فایل index.md (برای Markdown) یا tutorial.ipynb (برای Colab) ذخیره کنید. تصاویر استفاده شده در آموزش را نیز در همان دایرکتوری ذخیره کنید.

  5. محتوای جدید را به فورک خود اضافه کنید و یک درخواست pull باز کنید .

هنگام ایجاد یک درخواست pull، حتماً در بخش نظرات، به پیشنهاد اصلی با شماره مشکل GitHub آن اشاره کنید. برای مثال، اگر مشکل #123 بود، می‌توانید متن "Closes #123" را در توضیحات درخواست pull قرار دهید تا به پیشنهاد اصلی ارجاع داده شود و پس از انتشار آموزش، به طور خودکار به عنوان "تمام شده" علامت گذاری شود.

پس از باز کردن یک درخواست pull، یک یا چند نفر از مسئولین برای بررسی ارسال شما تعیین می‌شوند. بررسی‌کننده(گان) با شما همکاری خواهند کرد تا اطمینان حاصل شود که ارسال شما کامل، صحیح و مطابق با راهنمای سبک آموزش انجمن Earth Engine است.

پس از تأیید درخواست pull شما، آموزش شما توسط نگهدارندگان مخزن منتشر خواهد شد.