พื้นฐานการร่วมสร้างสําหรับ Microsoft Learn

เสร็จสมบูรณ์เมื่อ

มีคําบางคําที่ต้องทราบซึ่งจะช่วยให้คุณเข้าใจและเสร็จสิ้นกระบวนการร่วมสร้างเอกสาร ไม่จําเป็นต้องรู้ทุกอย่างที่เกิดขึ้นภายใต้ประทุน แต่ภาพรวมทั่วไปของวิธีการร่วมสร้างจะช่วยให้คุณเข้าใจว่าทําไมกระบวนการนี้ทํางานอย่างที่มันเป็น

ข้อมูลพื้นฐานของ Microsoft Learn และ GitHub

Microsoft Learn มีบทความหลายพันบทความ โมดูลการฝึกอบรม เว็บเพจ และอื่นๆ ซึ่งจําเป็นต้องจัดเก็บและเข้าถึงอย่างสม่ําเสมอโดยผู้สนับสนุนต่างๆ Microsoft Learn ใช้ GitHub เพื่อจัดเก็บเนื้อหาส่วนใหญ่นี้ GitHub เป็นแพลตฟอร์มที่ใช้ Git ซึ่งเป็นระบบควบคุมเวอร์ชันแบบกระจาย เพื่อจัดเก็บโครงการและอํานวยความสะดวกในการทํางานร่วมกันระหว่างผู้เกี่ยวข้องหลายรายที่มีเป้าหมายโครงการและไทม์ไลน์ที่แตกต่างกัน ซอฟต์แวร์ Git และ GitHub ช่วยให้คุณสามารถทํางานควบคู่ไปกับผู้สนับสนุนคนอื่น ๆ ในโครงการเดียวกันซึ่งอาจเป็นเนื้อหาเดียวกันแม้ในเวลาเดียวกันโดยไม่รบกวนงานของผู้อื่นโดยไม่ได้ตั้งใจ

เนื้อหาถูกเก็บไว้ในไฟล์ในที่เก็บ Git (ที่เก็บ) ที่โฮสต์บน GitHub ที่เก็บคือหน่วยเก็บข้อมูลที่ประกอบด้วยไฟล์ของโครงการและประวัติการตรวจทานแก้ไขไฟล์ ที่เก็บอาจเป็นแบบสาธารณะหรือส่วนตัว และ Microsoft Learn สร้างขึ้นมาจากการผสมผสานทั้งสองอย่าง ทุกคนสามารถมีส่วนร่วมในที่เก็บสาธารณะเมื่อพวกเขาได้ตั้งค่าบัญชี GitHub แล้ว ที่เก็บส่วนตัวจะใช้ได้เฉพาะกับผู้สนับสนุนที่เป็นพนักงานของ Microsoft หรือที่ได้รับสิทธิ์พิเศษเท่านั้น

ทําการแก้ไขเนื้อหา Microsoft Learn ที่จัดเก็บไว้ในที่เก็บ GitHub

สําหรับโครงการใด ๆ GitHub โฮสต์ที่เก็บหลักและส้อม ใด ๆ สําเนาคือสําเนาของ repo หลักที่ผู้ร่วมสร้างเอกสารทํางานของตนเอง สําเนาเป็นหนึ่งในวิธีการปกป้องเนื้อหาที่เผยแพร่ใน GitHub GitHub จะใช้สแนปช็อตของเนื้อหานั้นสําหรับสําเนาของคุณ เพื่อให้คุณสามารถทําการเปลี่ยนแปลงได้

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

แผนภาพที่แสดงสาขาการทํางานจากสาขาหลักในที่เก็บ GitHub เปลี่ยนแปลงในสาขาที่ทํางาน จากนั้นผสานกลับเป็นหลัก

การแก้ไขบทความเอกสารในที่เก็บสาธารณะอาจเริ่มต้นด้วยการแตะปุ่ม แต่มีหลายสิ่งที่เกิดขึ้นเบื้องหลัง เมื่อคุณเริ่มกระบวนการแก้ไขตามเบราว์เซอร์ จะมีการสร้างสําเนาของที่เก็บ (ถ้าคุณยังไม่มี) และใช้สําหรับการเปลี่ยนแปลงของคุณ คุณแก้ไขภายในสาขาในสําเนาของคุณ ซึ่งจะ ผสาน ไปยังสาขาปัจจุบันของที่เก็บหลัก เพื่อให้การเปลี่ยนแปลงทั้งหมดพร้อมใช้งาน

สร้างคําขอดึงข้อมูล

การผสานนี้เกิดขึ้นได้อย่างไร คุณจําเป็นต้องบอก GitHub— โดยเฉพาะ เจ้าของที่เก็บหลักและผู้เขียนบทความ ว่าการแก้ไขของคุณเสร็จสิ้นแล้วและพร้อมสําหรับการตรวจทาน การเผยแพร่ และโลกที่จะเห็น! ในการทําเช่นนี้ คุณต้องสร้างและส่งคําขอดึงข้อมูล

คําขอดึงข้อมูล (PR) เป็นข้อเสนอสําหรับการเปลี่ยนแปลงของคุณที่จะรวมจากสาขาในสําเนาที่คุณทํางานในที่เก็บข้อมูลสด สาขาหลัก เมื่อคุณทํางานในที่เก็บข้อมูลสาธารณะ ผู้ตรวจสอบคําร้องขอดึงข้อมูลของคุณจะได้รับการตรวจสอบโดยมนุษย์ก่อนที่จะทําการผสานรวมเสมอ นอกจากนี้ อาจมีการตรวจสอบอัตโนมัติบางอย่าง เช่น ความเข้ากันได้ของผสานและการตรวจสอบความถูกต้องของการสร้าง เมื่อการตรวจสอบเหล่านี้เสร็จสมบูรณ์และปัญหาใด ๆ ได้รับการแก้ไขแล้ว การเปลี่ยนแปลงของคุณจะถูกผสานเข้ากับสาขาที่ถ่ายทอดสดและพร้อมใช้งานบน Microsoft Learn!

เวิร์กโฟลว์สําหรับการร่วมสร้างเอกสารเล็กน้อย

โดยสรุป คุณจะทําตามขั้นตอนทั่วไปเหล่านี้เมื่อทําการเปลี่ยนแปลงเล็กน้อยกับเอกสารของ Microsoft โดยใช้ตัวแก้ไขเว็บใน GitHub:

แผนภาพของกระบวนการร่วมสร้างเอกสารประกอบแบบโอเพนซอร์สบน Microsoft Learn

  1. เมื่อคุณเปิดไฟล์ในเบราว์เซอร์ของคุณเพื่อแก้ไข สําเนาของที่เก็บสาธารณะจะถูกสร้างขึ้นให้คุณโดยอัตโนมัติ อีกทั้งสาขาในสําเนาของคุณจะถูกสร้างขึ้นซึ่งมักเรียกว่าสาขาโปรแกรมแก้ไข
  2. ทําการเปลี่ยนแปลงไฟล์
  3. สร้างคําขอดึงข้อมูลเพื่อเสนอว่าการเปลี่ยนแปลงของคุณได้รับการตรวจสอบและผสานแล้ว
  4. PR ของคุณต้องแก้ไขปัญหาใด ๆ และผ่านการตรวจสอบทั้งหมด
  5. PR ของคุณถูกผสานรวมเข้ากับสาขาหลักของที่เก็บแบบสด และการเปลี่ยนแปลงของคุณจะถูกเผยแพร่บน Microsoft Learn

ถัดไป มาดูแต่ละขั้นตอนอย่างใกล้ชิดยิ่งขึ้นเพื่อเรียนรู้วิธีดําเนินการ