โครงการ Linux Foundation

หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs

ข้อมูลสรุปของโปรเจ็กต์

องค์กรโอเพนซอร์ส:
มูลนิธิ Linux
ผู้เขียนด้านเทคนิค:
jaskiratsingh2000
ชื่อโปรเจ็กต์:
CHAOSS: จัดทำคู่มือสำหรับชุมชน CHAOSS
ระยะเวลาของโปรเจ็กต์:
ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

การอนุมัติโครงการ:

ปัจจุบัน กลุ่มทำงานภายในชุมชน CHAOSS ได้พัฒนาวิธีการทำงานของตนเองและจัดทำเอกสารของกระบวนการที่แตกต่างกันในระดับต่างๆ Working Groups ประกอบด้วยกลุ่มงาน Common Metrics WG, Diversity & Inclusion WG, Evolution, Risk และ Value ซึ่งได้กำหนดแนวทางการทำงานและการมีส่วนร่วมของตนเอง รวมถึงปรับใช้วิธีการสื่อสารและวัฒนธรรมการทำงานที่แตกต่างกัน กลุ่มทำงานเหล่านี้ตามตัวชี้วัดมีด้านที่มุ่งเน้นและภูมิหลังที่แตกต่างกัน ซึ่งเหมาะสมกับเมตริกที่เหมาะสมจะนำไปสู่การวิจัยและพัฒนาที่หลากหลายในหมวดหมู่กลุ่มทำงานที่เกี่ยวข้อง และทราบเส้นทางที่ถูกต้องในการนำไปสู่การวิจัยและการพัฒนาต่างๆ ในหมวดหมู่ที่เกี่ยวข้อง แต่กระบวนการสำหรับผู้มาใหม่และผู้ร่วมให้ข้อมูลเดิมอาจไม่ทราบวิธีเข้าร่วมหรือเดินบนเส้นทางที่เหมาะสมในการทำงานนั้นๆ

ทำให้สิ่งต่างๆ ภายในชุมชน CHAOSS ไม่เป็นมาตรฐาน ดังนั้น เพื่อให้ทราบกระบวนการที่เหมาะสมและพื้นฐานพื้นฐานของวัฒนธรรมการทำงานทั่วทั้งชุมชน เป้าหมายของคู่มือชุมชนคือการรวบรวมข้อมูลสำคัญไว้ที่ศูนย์กลางและทำให้ส่วนต่างๆ ของข้อมูลในโปรเจ็กต์ CHAOSS เป็นมาตรฐาน ข้อมูลสำคัญและการกำหนดมาตรฐานเน้นกระบวนการที่ CHAOSS ใช้เป็นหลักเพื่อให้ CHAOSS มีข้อตกลงว่าชุมชนทำงานให้สำเร็จอย่างไร ผู้มาใหม่จะเข้าร่วมและทำตามหลักการพื้นฐานของชุมชนได้อย่างไร ตลอดจนกระบวนการและเส้นทางสำหรับผู้มาใหม่หรือสมาชิกปัจจุบันที่ต้องปฏิบัติตามเพื่อให้ผู้นำใช้ในชุมชน CHAOSS ได้

คู่มือนี้ควรใช้เป็นคู่มือแนะนำวิธีการทำงานในโครงการ CHAOSS ให้กับสมาชิกปัจจุบันและสมาชิกใหม่ในชุมชน โครงการนี้เป็นองค์ประกอบของการสร้างสรรค์ในการรวบรวมและจัดระเบียบเนื้อหาสำหรับคู่มือ ตลอดจนองค์ประกอบทางเทคนิคในการกำหนดวิธีการนำเสนอคู่มือ

สิ่งที่จำเป็นสำหรับการดำเนินการนี้

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

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

  • วางนโยบายของชุมชน CHAOSS ให้เป็นทางการและเป็นระเบียบ โดยรวบรวมนโยบายทั้งหมดไว้ในที่เดียว
  • การสื่อสารแนะนำชุมชน พันธกิจ วิสัยทัศน์ และความเป็นผู้นำ
  • ทำความเข้าใจกับหลักปฏิบัติของชุมชน CHAOSS
  • หลักเกณฑ์การมีส่วนร่วม
  • การกำหนดเวิร์กโฟลว์ของโครงการ
  • การอธิบายวัฒนธรรมของชุมชน CHAOSS
  • คำถามทั่วไปที่พบบ่อย
  • การให้คำปรึกษา

คำอธิบายโครงการ:

คู่มือชุมชนจะแบ่งออกเป็น "หัวข้อ" ต่างๆ ซึ่งจะมีข้อมูลที่เหมาะสมและมีรายละเอียดสำหรับแต่ละหัวข้อ ส่วนต่างๆ สามารถแบ่งได้ดังต่อไปนี้

  • เกริ่นนำ
  • วิถีชุมชน CHAOSS
  • เส้นทางสู่ความเป็นผู้นำ
  • คำศัพท์
  • หลักเกณฑ์การมีส่วนร่วม
    • นักพัฒนาแอป
    • นักออกแบบ
    • ผู้เขียน
    • นักการตลาด
  • เมตริก
  • CHAOSScon
  • CHAOSScast
  • วิดีโอการประชุม
  • คำถามทั่วไปที่พบบ่อย
  • การให้คำปรึกษา
    • Google ซัมเมอร์โค้ด
    • การติดต่อ
    • ซีซันของเอกสารใน Google

โปรเจ็กต์อย่างละเอียด

1.) บทนำ:

ส่วนนี้จะเป็นเหมือนหน้าแรกของคู่มือชุมชน CHAOSS และครอบคลุมรายละเอียด ภาพรวม และการใช้งานคู่มือ โดยมีดังต่อไปนี้

A.) ในนี้จะมีข้อความต้อนรับพร้อมคำอธิบายสั้นๆ เกี่ยวกับชุมชน CHAOSS ซึ่งจะช่วยโน้มน้าวผู้อ่านให้เข้าไปอ่านคู่มือได้ และจะใส่ภาพต่อกันที่ถ่ายจากที่นี่ https://chaoss.community/chaoss-photo-album/ ซึ่งจะไฮไลต์การเคลื่อนไหวต่างๆ ภายในชุมชน B.) หน้านี้จะมีรายละเอียดเกี่ยวกับทุกส่วนโดยมีคำอธิบายบรรทัดเดียวที่อธิบายทุกหัวข้อและลิงก์ที่เหมาะสม C.) การใช้งานคู่มือ: มีการใช้คู่มือที่นี่อยู่แล้ว( shorturl.at/cqQU6) แต่เราจะปรับเปลี่ยนโครงสร้างการใช้งานคู่มือที่มีอยู่ใหม่ด้วยมาร์กดาวน์ที่ดีขึ้นด้วย ซึ่งจะรวมโฟลว์ของคู่มือไว้ด้วย(เราจะรวมว่าสิ่งต่างๆ จะเกิดขึ้นได้อย่างไรเมื่อมีคนต้องการเพิ่ม ลบ หรือพูดคุยเกี่ยวกับสิ่งต่างๆ ที่เกี่ยวข้องกับคู่มือ อาจติดตามผลขั้นตอนการสื่อสารสำหรับเรื่องต่างๆ ที่เกี่ยวข้องกับคู่มือด้วย) หลักเกณฑ์ของคู่มือ(ซึ่งรวมถึงการใช้งานภายในชุมชนและขอบเขต), การมีส่วนร่วมในคู่มือ ( ซึ่งรวมถึงวิธีที่ควรใช้ที่เก็บเพื่อทำการเปลี่ยนแปลง ทำการประชาสัมพันธ์ ปฏิบัติตามเทมเพลตในการเปลี่ยนแปลงคู่มือและคู่มือสไตล์) และแชร์ความคิดเห็นเกี่ยวกับคู่มือ ในส่วน "การแชร์ความคิดเห็น" เราจะรวมเทมเพลตและวิธีต่างๆ ที่ผู้ใช้จะติดตามผลเพื่อแจ้งข้อมูลหรือใช้ปัญหาเกี่ยวกับ GitLab ในการรับรายงานได้

2.) แนวทางของชุมชน CHAOSS:

แนวทางของชุมชน CHAOSS จะเป็นสิ่งสำคัญสำหรับผู้คนในการทำความเข้าใจแนวทางปฏิบัติและหลักเกณฑ์ของชุมชน เวิร์กโฟลว์จะช่วยให้มุ่งเน้นมากขึ้นและกำหนดขอบเขตแนวทางปฏิบัติของชุมชนได้เป็นวิธีที่ดีที่สุด ส่วนนี้ประกอบด้วยข้อมูลต่อไปนี้

A.) ค่านิยมทั่วไป: สรุปวิธีจัดการความยั่งยืน ความเปิดกว้าง และความโปร่งใสภายในชุมชน CHAOSS ฉันจะอธิบายเกี่ยวกับค่านิยมเหล่านี้ซึ่งผู้ใช้ใหม่หรือผู้ใช้เดิมควรทำความเข้าใจและนำไปพิจารณาขณะทำงานภายในร่วมกับชุมชน B.) หลักเกณฑ์ของชุมชน: ซึ่งประกอบด้วยการเข้าร่วมกับชุมชน CHAOSS และปฏิบัติตามข้อกำหนดพื้นฐาน และยังจะอธิบายวัฒนธรรมการทำงานที่เกิดขึ้นภายในชุมชนด้วย (สิ่งที่ควรและไม่ควรทำ) ซึ่งจะรวมรายการตรวจสอบหลักของผู้ร่วมให้ข้อมูล/ผู้บำรุงรักษา และบอกให้คนอื่นๆ ทราบว่าพวกเขาควรทำงานกับผู้บำรุงรักษาอย่างไรและรายการตรวจสอบของพวกเขาคืออะไร C.) กลุ่มทำงาน: หน้านี้( https://chaoss.community/participate/ ) มีข้อมูลเกี่ยวกับคณะทำงาน เช่น คำอธิบาย WG, ลิงก์ Repo และข้อมูลการประชุม แต่ในคู่มือ เราจะมาอธิบายวิธีการเข้าร่วมกลุ่มทำงานต่างๆ และทำความเข้าใจกระบวนการประเมินเมตริก การทำความเข้าใจวัฒนธรรมการทำงานสำหรับ WG ที่เกี่ยวข้อง และวิธีเป็นผู้มีส่วนร่วมหลักของกลุ่มการทำงานต่างๆ

3.) เส้นทางสู่ความเป็นผู้นำ:

การเป็นผู้นำในโครงการโอเพนซอร์สอาจมีความสำคัญต่อความสำเร็จในวงการการค้าของชุมชน ดังนั้น เราจะกล่าวถึงข้อมูลต่อไปนี้

A.) ความเป็นผู้นำด้านเทคนิค: ซึ่งรวมถึงกระบวนการและความรับผิดชอบของผู้ดูแลระบบ Repo ผู้เขียนเอกสาร และผู้ดูแลจัดการเว็บไซต์ ข. ภาวะผู้นำการกำกับดูแล: ประกอบด้วยเส้นทางของสมาชิกคณะกรรมการและผู้มีอำนาจตัดสินใจ ค.) ความเป็นผู้นำด้านการปฏิบัติงาน: ประกอบด้วยเส้นทางสำหรับ Community Manager

4.) คำศัพท์

คำศัพท์จะช่วยอธิบายคำศัพท์และองค์ประกอบต่างๆ ที่ใช้บ่อยภายในชุมชน CHAOSS นอกจากนี้ ฉันจะรวมหลักเกณฑ์การใช้คำศัพท์ เช่น การใช้อักษรตัวพิมพ์ใหญ่ ตัวย่อ และคำที่ควรหลีกเลี่ยงพร้อมเหตุผล ข้อกำหนดที่เราจะรวมไว้ได้แก่ โครงการ CHAOSS, สถานภาพชุมชนโอเพนซอร์ส, การตรวจสอบโค้ด, คณะทำงาน, เมตริกซอฟต์แวร์โอเพนซอร์ส, เมตริกทั่วไป, ความหลากหลาย และตัวชี้วัดความไม่แบ่งแยก, คณะทำงานวิวัฒนาการ, คณะทำงานความเสี่ยง, คณะทำงานด้านคุณค่า, การเผยแพร่เมตริก, ด้านที่มุ่งเน้น

5.) หลักเกณฑ์การสนับสนุน:

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

A.) ทำความเข้าใจแผนกลยุทธ์ของชุมชน: หัวข้อนี้จะกล่าวถึงภาพรวมของแผนกลยุทธ์ของชุมชน CHAOSS ซึ่งจะช่วยให้ผู้ใช้ทราบว่าแนวทางหรือกระบวนการใดในการปฏิบัติตามลำดับความสำคัญของงานต่างๆ ภายในโครงการ CHAOSS B.) มีการอธิบายสิ่งที่จำเป็นสำหรับการมีส่วนร่วมในงานต่างๆ เช่น การพัฒนา การจัดทำเอกสาร การออกแบบ การทดสอบ เป็นต้น ค.) ให้ภาพรวมคร่าวๆ เกี่ยวกับการทำงานของ GitLab ง.) คู่มือผู้ตรวจสอบ/ผู้บำรุงรักษา

ส่วนนี้ยังมี "บทบาทและความรับผิดชอบ" ของหมวดหมู่การมีส่วนร่วมแต่ละหมวดหมู่ ซึ่งมีดังนี้

a.) การออกแบบ: ส่วนย่อยนี้จะมี "กระบวนการทำงานการออกแบบ (CHAOSS)" และหลักเกณฑ์การออกแบบ ซึ่งประกอบด้วยหลักการในการออกแบบ กระบวนการ และเครื่องมือที่ใช้ ซึ่งผู้ร่วมงานต้องปฏิบัติตามเมื่อมีส่วนร่วมในงานออกแบบ ข.) การพัฒนา: ส่วนนี้จะมีคำแนะนำเกี่ยวกับการมีส่วนร่วมในฐานของโค้ด ซึ่งจะประกอบด้วยข้อกำหนดทางเทคนิค โครงสร้างโครงการ การตั้งค่าโครงการ(Augur, Cregit, GremoireLab) ค.) เอกสารประกอบ: ตัวเลือกนี้จะรวมแหล่งข้อมูลสำหรับเอกสารประกอบต่างๆ ซึ่งรวมถึงเครื่องมือและสไตล์การแปล ง.) OUTREACH: ซึ่งรวมถึงวิธีที่ผู้ร่วมให้ข้อมูลจะสามารถสนับสนุนชุมชน CHAOSS ในการขยายการเติบโต เช่น การเขียนบล็อก, การใช้ Social Handles, การจัดมีตติ้งและกิจกรรม

6.) เมตริก

ปัจจุบันเว็บไซต์ชุมชน CHAOSS มีข้อมูลของ Metric Releases( https://chaoss.community/metric/ ) และเราต้องเข้าใจวิธีปฏิบัติตามกระบวนการเพื่อทำให้เว็บไซต์เมตริกของตนปรากฏบนเว็บไซต์นั้น ดังนั้น ส่วนนี้จะมีข้อมูลที่ช่วยให้ผู้ใช้ทราบกระบวนการและการทํางานเพื่อเปิดตัวเมตริกของตัวเอง

7.) CHAOSScon:

ข้อมูลเกี่ยวกับ CHAOSScon มีอยู่ใน GitHub( https://github.com/chaoss/governance/blob/master/community-handbook/chaosscon.md ) และเว็บไซต์( https://chaoss.community/CHAOSScon-2020-NA/ ) แล้ว แต่การเพิ่มรายละเอียดและข้อมูลอธิบายกระบวนการและการจัดการต่างๆ ใน Handbook จะเหมาะสมกว่า ในคู่มือจะมีข้อมูลต่อไปนี้

A.) รายละเอียดเกี่ยวกับคณะกรรมการการจัดระเบียบ: ซึ่งจะอธิบายถึงขั้นตอนการเข้าร่วมในคณะกรรมการจัดงานของ CHAOSScon B) การจัดการสำหรับขั้นตอนการเรียกข้อเสนอ: ประกอบด้วยการจัดการการลงทะเบียนผู้เขียน การส่งข้อเสนอและเอกสาร กระบวนการตรวจสอบ และกระบวนการอนุมัติ C.) การจัดการและการเผยแพร่โปรแกรม CHAOSScon ง.) วิธีจัดการโฆษณาและการตลาด จ.) วิธีจัดการข้อเสนอสำหรับการสนับสนุนและเงินทุน รวมถึงแพ็กเกจ

8.) CHAOSScast:

ดูข้อมูล CHAOSScast ได้ที่นี่ https://github.com/chaoss/governance/blob/master/community-handbook/chaosscast.md และจะรวมอยู่ในคู่มือด้วยพร้อมกับรายละเอียดเพิ่มเติมบางส่วน เช่น การเข้าร่วม คณะกรรมการการจัดระเบียบ การโฆษณา และสื่อการตลาด

9.) วิดีโอการประชุม:

ซึ่งจะมีวิดีโอการประชุมทั้งหมดพร้อมกับคำอธิบาย เช่น ผู้เข้าร่วม กำหนดการ และอื่นๆ ที่เกิดขึ้นในอดีตและมีอยู่ใน YouTube

10.) คำถามทั่วไปที่พบบ่อย

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

11.) Google Summer of Code:

ส่วนนี้จะมีข้อมูลเกี่ยวกับ Google Summer of Code, เกณฑ์คุณสมบัติ และข้อมูลเกี่ยวกับวิธีเข้าร่วมในชุมชน CHAOSS ใน Google Summer of Code นี้ ส่วนนี้ยังมีเทมเพลตข้อเสนอที่ผู้ใช้สามารถร่างข้อเสนอ ตลอดจนบทบาทและความรับผิดชอบ นอกจากนี้ ยังมีข้อมูลที่ช่วยให้สมาชิกชุมชนที่มีอยู่เรียนรู้กระบวนการเป็นผู้ดูแลระบบองค์กรและที่ปรึกษา

  1. การติดต่อ:

ส่วนนี้จะมีข้อมูลเกี่ยวกับการติดต่อ เกณฑ์การมีสิทธิ์ และข้อมูลเกี่ยวกับวิธีที่ผู้คนสามารถมีส่วนร่วมภายใต้ชุมชน CHAOSS ใน Outreachy โดยจะมีบทบาทและความรับผิดชอบต่างๆ ซึ่งรวมถึงกระบวนการเป็นผู้ดูแลระบบองค์กรและที่ปรึกษา

  1. ซีซันของเอกสารใน Google:

ส่วนนี้จะมีข้อมูลเกี่ยวกับ GSoD, เกณฑ์คุณสมบัติ และข้อมูลเกี่ยวกับวิธีเข้าร่วมในชุมชน CHAOSS ใน GSoD ซึ่งจะประกอบด้วยบทบาทและความรับผิดชอบ รวมถึงกระบวนการเป็นผู้ดูแลระบบองค์กรและที่ปรึกษา

ผลลัพธ์ที่คาดไว้ของโปรเจ็กต์:

คู่มือมีบทบาทสำคัญในทุกชุมชน ในทำนองเดียวกัน คู่มือการใช้ทั้งชุมชนของ CHAOSS ฉบับนี้จะส่งผลให้มีเอกสารที่เป็นระเบียบและมีรายละเอียดมากขึ้นสำหรับชุมชน CHAOSS ผู้ใช้ใหม่ที่เข้าร่วมชุมชน ตลอดจนสมาชิกปัจจุบันในชุมชนจะเข้าใจหลักการพื้นฐานและการทำงานของชุมชน CHAOSS ได้ง่ายๆ นอกจากนั้น คู่มือนี้ยังนำไปสู่กระบวนการและเส้นทางต่างๆ ที่นำไปสู่วัฒนธรรมการทำงานต่างๆ ภายในชุมชน CHAOSS

รายละเอียดทางเทคนิค:

ผมเสนอให้ใช้แพลตฟอร์ม Gitbook ในการดูแลรักษาคู่มือ เนื่องจากเป็นโครงการการทำงานร่วมกันที่ใช้งานง่ายสำหรับทีมเพื่อให้ทำงานได้อย่างมีประสิทธิภาพและประสิทธิผล ฟีเจอร์บางอย่างของแพลตฟอร์ม GitBook มีดังนี้

  • WYSIWYG: เครื่องมือแก้ไขข้อความที่มีประสิทธิภาพและสวยงาม
  • มาร์กดาวน์: การสนับสนุนทางลัดมาร์กดาวน์ได้อย่างมีประสิทธิภาพและมีประสิทธิภาพ
  • การฝัง Rich: ฝังเนื้อหาเว็บภายนอก เช่น วิดีโอ ข้อมูลโค้ด บทความ เพลง และอื่นๆ
  • หน้าแดชบอร์ดสำหรับนักเขียน: มีหน้าแดชบอร์ดอัจฉริยะสำหรับนักเขียน ซึ่งรองรับการแก้ไขภาพ
  • ฉบับร่าง: ร่างการเปลี่ยนแปลงใหม่และทำงานร่วมกันแบบไม่พร้อมกัน
  • ความคิดเห็นเกี่ยวกับการสนับสนุน: พูดคุยและตรวจสอบการเปลี่ยนแปลงฉบับร่าง
  • ติดตามประวัติการเขียน: ติดตามได้ทุกอย่าง ตรวจสอบและยกเลิกการเปลี่ยนแปลง
  • ข้อมูลเชิงลึก: นอกจากนี้ยังสนับสนุนข้อมูลเชิงลึกที่ติดตามการเข้าชม การให้คะแนน และคุณภาพของเนื้อหา
  • การซิงค์ GitHub: เก็บเวิร์กโฟลว์และซิงค์เอกสารด้วย GitHub
  • การปรับแต่ง การสร้างแบรนด์: โดเมนที่กำหนดเอง โลโก้ที่กำหนดเอง แบบอักษร สี ธีม ส่วนหัว ฯลฯ

นี่คือรูปภาพบางส่วนที่แสดงให้เห็นความเป็นไปของแพลตฟอร์ม

  • shorturl.at/GNQR4
  • shorturl.at/gATZ8
  • shorturl.at/qrE57
  • shorturl.at/rFRX6
  • shorturl.at/eyLW1
  • shorturl.at/rwHS8

-- คู่มือจะโฮสต์ไว้ที่ใด

คู่มือนี้จะโฮสต์อยู่บน GitBook เอง โดยที่ GitHub มีกลไกที่เหมาะสมสำหรับโดเมนที่กำหนดเอง, ข้อผิดพลาดทั่วไป และ SEO

โดเมนที่กำหนดเอง: หากชุมชน CHAOSS ต้องการโฮสต์อยู่บนโดเมนที่กำหนดเอง ชุมชนดังกล่าวจะแสดงเป็น docs.chaoss.community นี้ ซึ่งองค์กรจำเป็นต้องสร้างโดเมนย่อยที่ต้องการเท่านั้น หากต้องการตั้งค่าโดเมนองค์กร ให้ไปที่การตั้งค่าขององค์กรในแพลตฟอร์ม Gitbook ตัวอย่างรูปภาพ: shorturl.at/GNQR4

พื้นที่ของ GitBook จะให้บริการผ่าน CDN ของเราเองที่เปิดใช้ HTTPS โดยค่าเริ่มต้น ใบรับรองออกโดย LetsEncrypt

โดเมนที่รองรับ:

  • โดเมนย่อย: www.example.com
  • โดเมนที่กำหนดเอง: docs.example.com

-- วิธีซิงค์ Gitbook กับ GitHub เพื่อให้แก้ไขได้ทั้ง 2 แพลตฟอร์มอย่างมีประสิทธิภาพ

การผสานรวมกับ GitHub ใช้งานง่ายมาก หากใครเปลี่ยนแปลงเนื้อหาบางอย่างใน GitBook การแก้ไขของผู้ใช้จะถูกพุชไปยังที่เก็บ GitHub ในทางกลับกัน การคอมมิตที่พุชไปยังที่เก็บ GitHub จะถูกนำเข้าภายใน GitBook

ตั้งค่าการผสานรวม GitHub:

  • จากพื้นที่ของคุณภายในแพลตฟอร์ม GitBook ให้คลิกแท็บการผสานรวม > GitHub
  • อนุญาตให้ GitBook เข้าถึงบัญชี GitHub ที่ลิงก์กับองค์กร
  • ไปที่ GitHub ขององค์กรและสร้างที่เก็บสำหรับ "HandBook" เช่น หนังสือคู่มือ Chaoss
  • ต่อไปให้เลือกที่เก็บชื่อ Chaoss-handbook ที่คุณต้องการเชื่อมต่อภายในตัวเลือกการให้สิทธิ์ภายในแพลตฟอร์ม GitBook

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

จบเพียงเท่านี้ ทุกคนจะแก้ไขต่อไปจากที่เก็บของ GitBook หรือ GitHub ได้

-- วิธีแก้ไขหน้าในแพลตฟอร์ม GitBook

ผู้ที่ต้องการแก้ไขทุกอย่างในแพลตฟอร์ม GitBook ต้องเข้าร่วมแพลตฟอร์ม GitBook ด้วยลิงก์คำเชิญหรือลิงก์เข้าร่วม GitBook รองรับการแก้ไขภาพซึ่งผู้ใช้สามารถเขียนภายในหน้าต่างๆ ได้โดยตรง

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

การเปลี่ยนแปลงที่ทำในฉบับร่างจะสามารถทำได้โดยผู้ใช้สามารถมีส่วนร่วมในเอกสารเดียวกันพร้อมกับสมาชิกคนอื่นๆ ได้พร้อมกันโดยไม่ทำให้เกิดข้อขัดแย้งใดๆ! นี่คือสิ่งที่เราเรียกว่าการแก้ไขแบบอะซิงโครนัสและการแก้ปัญหาความขัดแย้ง

ฉบับร่างเวอร์ชันแรกอาจยังไม่พร้อมที่จะเผยแพร่ทันทีเสมอไป ใช้ ""บันทึก"" เมื่อต้องการทำงานต่อในภายหลัง หรือหากเนื้อหายังไม่พร้อมที่จะ"รวม"

เมื่อแก้ไขเสร็จแล้ว คุณจะ "รวม" ฉบับร่างได้ เนื้อหาที่คุณเขียนหรือการเปลี่ยนแปลงที่คุณทำจะเปิดเผยต่อสมาชิกทีมและ/หรือเผยแพร่ต่อสาธารณะ

ตัวอย่างรูปภาพ: shorturl.at/gATZ8 และ shorturl.at/qrE57

-- โครงสร้างเนื้อหา:

สารบัญ: แต่ละส่วนสามารถประกอบด้วยหน้าได้มากตามที่คุณต้องการในการเขียนเอกสารประกอบ หน้าเหล่านี้ทั้งหมดจะปรากฏที่ด้านซ้ายของหน้าจอในสิ่งที่เราเรียกว่าสารบัญ คุณสามารถจัดการหน้าเว็บได้จากสารบัญ ได้แก่ สร้างหน้าเว็บใหม่ กลุ่มหน้าเว็บ เพิ่มลิงก์ภายนอก เพิ่มรูปแบบ นำเข้าเอกสารภายนอก เช่น เว็บไซต์หรือไฟล์ที่มี Markdown (.md หรือ .markdown), HTML (.html), Microsoft Word (.docx)

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

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

ลิงก์ภายนอก: รายการเหล่านี้เป็นลิงก์ภายนอกและไม่มีเนื้อหาใดๆ ในตัวแก้ไข ซึ่งทำหน้าที่หลักในการลิงก์ไปยังเว็บไซต์ภายนอก

ตัวแปร: คุณสร้างเนื้อหาสำรองลงในเอกสารประกอบได้โดยสร้างตัวแปร วิธีนี้จะมีประโยชน์ในการบันทึก API, ไลบรารี หรือคำแปลหลายเวอร์ชัน

ตัวอย่างรูปภาพ: shorturl.at/eyLW1 และ shorturl.at/rFRX6

-- คู่มือจะแสดงฝั่งไคลเอ็นต์อย่างไร

คู่มือชุมชน Chaoss สามารถเข้าถึงได้ด้วยโดเมนย่อยซึ่งอาจเป็น https://docs.chaoss.community และจะแสดงในลักษณะต่อไปนี้ในฝั่งผู้ใช้

  • คู่มือ Mattermost - https://handbook.mattermost.com/
  • Linux Foundation Community Bridge - https://docs.linuxfoundation.org/docs/ และอีกมากมาย

ไทม์ไลน์ของโปรเจ็กต์:

1.) ระยะผูกมัดของชุมชน (17 ส.ค. - 13 ก.ย.)

A.) สัปดาห์ที่ 1-4

  • พูดคุยเรื่องโปรเจ็กต์กับที่ปรึกษา
  • ค้นคว้าและรวบรวมข้อมูลที่จำเป็นสำหรับส่วนต่างๆ ภายในโครงการ รวมถึงถามคำถามกับชุมชนเพื่อความชัดเจน
  • ชี้แจงกับชุมชนว่าควรใช้แพลตฟอร์มใดสำหรับคู่มือ (ฉันขอแนะนำ GitBook) และตั้งค่า
  • ให้ความช่วยเหลือเกี่ยวกับปัญหาของเอกสาร

2.) ระยะการพัฒนาเอกสาร (14 ก.ย. - 30 พ.ย.)

A.) สัปดาห์ที่ 5 (14 ก.ย. - 20 ก.ย.)

  • ฉบับร่าง" ส่วนบทนำ

B.) สัปดาห์ที่ 6 (21 ก.ย. - 27 ก.ย.)

  • ร่างส่วน "The CHAOSS Community Way"

C.) สัปดาห์ที่ 7 (28 ก.ย. - 4 ต.ค.)

  • ร่างส่วน "เส้นทางสู่ความเป็นผู้นำ"
  • ร่างส่วน "คำศัพท์"

D.) สัปดาห์ที่ 8 (5 ต.ค. - 11 ต.ค.)

  • ร่างแผนกลยุทธ์ของชุมชน
  • หลักเกณฑ์การมีส่วนร่วมในการออกแบบฉบับร่าง

E.) สัปดาห์ที่ 9 (12 ต.ค. - 18 ต.ค.)

  • ส่วนการพัฒนาฉบับร่าง

F.) สัปดาห์ที่ 10 (19 ต.ค. - 25 ต.ค.)

  • หลักเกณฑ์ของส่วนการเขียนและการติดต่อ

G.) สัปดาห์ที่ 11 (26 ต.ค. - 1 พ.ย.)

  • ส่วนเมตริกฉบับร่าง
  • ส่วน CHAOSScon ฉบับร่าง

H.) สัปดาห์ที่ 12 (2-8 พ.ย.)

  • ออกแบบส่วนการประชุม

  • ร่างคำถามที่พบบ่อยทั่วไปของชุมชน

    I.) สัปดาห์ที่ 13 (9 พ.ย. - 15 พ.ย.)

  • ฉบับร่างเกี่ยวกับหลักเกณฑ์ GSoC

J.) สัปดาห์ที่ 14 (16 - 22 พ.ย.)

  • ฉบับร่างเกี่ยวกับหลักเกณฑ์การติดต่อ

K.) สัปดาห์ที่ 15 (23 พ.ย. - 29 พ.ย.)

  • บัฟเฟอร์เวลา การขัดเกลาและปรับปรุงเอกสารทั้งหมด

3.) ช่วงประเมิน (30 พ.ย. - 5 ธ.ค.)

A.) สัปดาห์ที่ 16:

  • ร่างรายงานโปรเจ็กต์
  • กรอกข้อมูลการประเมินสำหรับโครงการ

การโต้ตอบในชุมชน

1.) การมีส่วนร่วมและพูดคุยกับชุมชน

ฉันได้สำรวจในชุมชน CHAOSS ตั้งแต่เดือนเมษายน 2020 และได้มีส่วนร่วมในการพูดคุยที่หลากหลายกับสมาชิกในชุมชนและกับที่ปรึกษาโปรเจ็กต์เฉพาะของฉัน( Georg Link และ Armstrong Foundjem) การพูดคุยดังกล่าวที่กระตุ้นความสนใจของสมาชิกชุมชนมากขึ้นคือ "การเสนอ Gitbook เป็นแพลตฟอร์มสำหรับโฮสต์คู่มือชุมชน" ซึ่งสามารถดูได้ในชุดข้อความของ CHAOSS ที่เก็บถาวร โดยใช้ชื่อว่า "การเสนอ Gitbook" เป็นแพลตฟอร์มสำหรับโฮสต์คู่มือชุมชน นอกจากนี้ ยังได้เข้าร่วมในการโทรรายสัปดาห์ของชุมชน ซึ่งช่วยให้ฉันมอบข้อมูลอัปเดตต่างๆ ให้กับชุมชน

2.) คุณจะรวบรวมข้อมูลที่จำเป็นสำหรับโครงการนี้อย่างไร

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

เราจะค้นคว้าข้อมูลในหัวข้อต่างๆ ตาม CHAOSS และติดตามชุดข้อความที่อยู่ในรายชื่ออีเมล ฉันจะลองถามคำถามที่ชัดเจนจาก Mentor และชุมชนตามข้อกำหนด

ฉันจะเข้าร่วมการโทรรายสัปดาห์ด้วยเพื่อให้พูดคุยกันได้อย่างกระชับ

3.) คุณจะเสนอว่าอย่างไรเพื่อให้ชุมชนทราบถึงความคืบหน้าของคุณ ตลอดจนปัญหาหรือคำถามที่คุณอาจสงสัยตลอดโครงการ

เพื่อให้เกิดความยืดหยุ่นและความโปร่งใส เราจะพยายามสื่อสารผ่านการสนทนาในรายชื่ออีเมลเพื่อถามข้อสงสัยต่างๆ ของฉัน

ฉันจะแชร์ความคืบหน้ารายสัปดาห์ในรูปแบบบล็อกโพสต์ซึ่งจะมีเอกสารประกอบและความท้าทายที่พบ ซึ่งจะแชร์ในรายชื่ออีเมลของชุมชนเองเพื่อเข้าถึงกลุ่มเป้าหมายที่ใหญ่ขึ้นภายในองค์กรโอเพนซอร์ส

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

นอกจากนี้ฉันวางแผนที่จะสร้างกระดาน Trello ที่ประกอบด้วยงานรายสัปดาห์ที่มี จากนั้น Mentor สามารถใช้กระดานนี้เพื่อทำความเข้าใจปัญหาและฟีเจอร์ที่กำลังใช้งานอยู่ให้ชัดเจนและกระชับ

4.) คุณจะทำอย่างไรหากไม่สามารถทำโครงการได้โดยมีที่ปรึกษาไม่อยู่

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

อย่างไรก็ตาม หาก Mentor ไม่ได้อยู่หรือไม่ว่างในช่วงเวลาที่ฉันต้องการความช่วยเหลือ เราจะแชร์ปัญหาที่พบในชุมชน CHAOSS ฉันมั่นใจว่าจะมีคนช่วยฉันได้เมื่อเจออุปสรรคใดๆ นอกจากนี้ ฉันจะแชร์ปัญหากับฟอรัม/ชุมชนนักพัฒนาซอฟต์แวร์ออนไลน์ เช่น dev.to

ยิ่งไปกว่านั้น เราขอแนะนำให้คุณลองเข้าร่วมการประชุมทางโทรศัพท์รายสัปดาห์เพื่อขอความช่วยเหลือภายในชุมชน CHAOSS เพื่อถามข้อสงสัยต่างๆ