การเขียนบทแนะนำสำหรับชุมชนครั้งแรก

พื้นที่นี้มีไว้สำหรับผู้ใช้ Earth Engine ที่ต้องการแชร์ความรู้กับชุมชน Earth Engine ที่เหลือ บทแนะนำในส่วนนี้สร้างขึ้นโดยผู้ใช้ Earth Engine สำหรับผู้ใช้ Earth Engine โดยมีไว้สำหรับผู้ใช้ทุกระดับ ตั้งแต่ผู้เริ่มต้นไปจนถึงผู้ใช้ที่มีความเชี่ยวชาญมากขึ้น

คุณส่งบทแนะนำเป็นข้อความธรรมดาและโค้ดที่จัดรูปแบบโดยใช้ภาษามาร์กอัป Markdown หรือเป็น Colab Notebook ที่มีมาร์กดาวน์และโค้ด Python ที่เรียกใช้ได้ โดยทั่วไปแล้ว บทแนะนำที่สร้างขึ้นโดยใช้ไลบรารีของไคลเอ็นต์ JavaScript ของ Earth Engine จะเขียนในรูปแบบ Markdown ส่วน Colab เหมาะสำหรับบทแนะนำที่อิงตามไลบรารีของไคลเอ็นต์ Python ของ Earth Engine

ก่อนเริ่มต้น

หลักจรรยาบรรณ

ทีม Earth Engine มุ่งมั่นที่จะส่งเสริมชุมชนที่ปราศจากการคุกคามและให้ทุกคนเข้ามามีส่วนร่วมได้ โปรดทำความคุ้นเคยกับหลักจรรยาบรรณ ก่อนร่วมสนับสนุน

การเข้าร่วม GitHub

เราแชร์และตรวจสอบบทแนะนำชุมชนของ Earth Engine ผ่าน GitHub หากยังไม่มีบัญชี GitHub คุณต้องสร้างบัญชีที่ https://github.com/join ก่อน

การเสนอให้สร้างบทแนะนำ

ก่อนที่จะใช้เวลาและความพยายามอย่างมากในการสร้างบทแนะนำใหม่ เราขอให้ผู้มีโอกาสเป็นผู้ร่วมให้ข้อมูลส่งข้อเสนอแบบง่ายๆ พร้อมข้อมูลพื้นฐานบางอย่าง ซึ่งจะช่วยให้ผู้เขียนสามารถทำงานร่วมกับผู้ดูแลเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ Earth Engine เพื่อมุ่งเน้นไปที่บทแนะนำที่ให้คุณค่ามากที่สุดแก่ชุมชนผู้ใช้ Earth Engine นอกจากนี้ยังช่วยประหยัดเวลาด้วยการหลีกเลี่ยงการสื่อสารไปมาที่อาจเกิดขึ้นระหว่างกระบวนการตรวจสอบ

เสนอให้สร้างบทแนะนำ

การตั้งค่าครั้งแรก

หากคุณส่งบทแนะนำไปยังที่เก็บ GitHub ของชุมชน Earth Engine เป็นครั้งแรก โปรดทำตามขั้นตอนเหล่านี้ก่อนเริ่ม สร้างบทแนะนำ

1. ยอมรับข้อตกลงการอนุญาตให้ใช้สิทธิสำหรับผู้ร่วมให้ข้อมูล (CLA) ที่

   https://cla.developers.google.com

2. อ่านและทำความเข้าใจคู่มือรูปแบบการสอนของชุมชน

การเขียนและส่งบทแนะนำ

เมื่อผู้ดูแลยอมรับข้อเสนอการสอนแล้ว คุณจะมีตัวเลือกหลายอย่างในการแก้ไขบทแนะนำและส่งไปยังที่เก็บชุมชนของ Earth Engine ดังนี้

เริ่มต้นใช้งานมาร์กดาวน์อย่างรวดเร็ว

คุณสามารถ Fork ที่เก็บ GitHub และสร้างบทแนะนำใหม่ได้โดยตรงผ่าน เว็บไซต์ GitHub เพื่อเริ่มต้นใช้งานอย่างรวดเร็วโดยไม่ต้องใช้เครื่องมือหรือ การตั้งค่าเพิ่มเติม

1. ลงชื่อเข้าใช้ GitHub หากยังไม่ได้ดำเนินการ

2. หากต้องการสร้างและแก้ไขไฟล์บทแนะนำใหม่ ให้คลิกบทแนะนำใหม่ ระบบจะแจ้งให้คุณ Fork ที่เก็บหากจำเป็น

   บทแนะนำใหม่

3. ป้อนชื่อไฟล์บทแนะนำของแบบฟอร์ม

   your-tutorial-name/index.md

   โดย your-tutorial-name คือชื่อย่อของบทแนะนำของคุณใน ตัวพิมพ์เล็กทั้งหมด ใช้ขีดกลาง ("-") เพื่อแยกคำ อย่าเว้นวรรค หรือใช้วรรคตอนอื่นๆ ในชื่อโฟลเดอร์

4. แก้ไขบทแนะนำในโปรแกรมแก้ไขไฟล์ GitHub ได้โดยตรง โดยใช้ "แสดงตัวอย่าง" เพื่อยืนยันเอาต์พุตที่จัดรูปแบบแล้ว (ดูการแก้ไขไฟล์ใน ที่เก็บในเอกสารประกอบของ GitHub ด้วย)

5. เมื่อพร้อมแล้ว ให้คอมมิตการเปลี่ยนแปลงและเปิดคำขอพุล

สมุดบันทึก Colab

คลิกที่นี่เพื่อเริ่มเขียนบทแนะนำใน Colab

บทแนะนำ Colab ใหม่

ซึ่งจะเปิด Notebook ที่มีวิธีการเขียนและ ส่งบทแนะนำ

ขั้นสูง

หากคุณคุ้นเคยกับ GitHub, Git และเครื่องมือที่เกี่ยวข้องอยู่แล้ว กระบวนการโดยรวมในการส่งบทแนะนำทั้งในรูปแบบ Markdown และ Colab จะเหมือนกัน ดังนี้

1. Fork และโคลนที่เก็บ google/earthengine-community GitHub

2. สร้างไดเรกทอรีภายใต้ tutorials โดยใช้ชื่อย่อที่แปลงเป็น URL ของ บทแนะนำ (เช่น tutorials/my-amazing-tutorial)

3. เพิ่มส่วนหัวที่เหมาะสมสำหรับ Markdown หรือ Colab

4. คอมมิตบทแนะนำไปยังไดเรกทอรีใหม่โดยใช้ชื่อไฟล์ index.md (สำหรับมาร์กดาวน์) หรือ tutorial.ipynb (สำหรับ Colab) คอมมิตรูปภาพที่ใช้ใน บทแนะนำไปยังไดเรกทอรีเดียวกัน

5. ส่งเนื้อหาใหม่ไปยัง Fork ของคุณ แล้วเปิดคำขอ ดึงข้อมูล

เมื่อสร้างคำขอดึงข้อมูล โปรดอ้างอิงถึงข้อเสนอเดิมโดยใช้หมายเลขปัญหาใน GitHub ในส่วนความคิดเห็น ตัวอย่างเช่น หากปัญหาคือ #123 คุณจะต้องวางข้อความ "ปิด #123" ในคำอธิบายคำขอ Pull เพื่อ อ้างอิงข้อเสนอเดิม และทำเครื่องหมายว่าเสร็จสิ้นโดยอัตโนมัติเมื่อ เผยแพร่บทแนะนำแล้ว

เมื่อเปิด Pull Request แล้ว ระบบจะมอบหมายผู้ดูแลอย่างน้อย 1 คนให้ตรวจสอบการส่งของคุณ ผู้ตรวจสอบจะทำงานร่วมกับคุณเพื่อให้แน่ใจว่าข้อมูลที่คุณส่งมานั้นสมบูรณ์ ถูกต้อง และสอดคล้องกับคู่มือรูปแบบการสอนของชุมชน Earth Engine

เมื่อคำขอพุลได้รับการอนุมัติแล้ว ผู้ดูแลที่เก็บจะเผยแพร่บทแนะนำของคุณ