โครงการ Linux Foundation

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

สรุปโปรเจ็กต์

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

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

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

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

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

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

ความจำเป็นในการใช้แอปคืออะไร

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

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

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

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

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

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

รายละเอียดของสิ่งที่ส่งมอบของโปรเจ็กต์

1.) บทนำ:

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

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

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

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

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

3.) เส้นทางสู่ภาวะผู้นำ:

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

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

4.) คำศัพท์

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

5.) หลักเกณฑ์การมีส่วนร่วม

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

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

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

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

6.) เมตริก

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

7.) CHAOSScon:

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

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

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. Outreachy:

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

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

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

ผลลัพธ์ของโครงการ:

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

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

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

  • WYSIWYG: เครื่องมือแก้ไขข้อความที่มีประสิทธิภาพและสวยงาม
  • มาร์กดาวน์: รองรับทางลัดมาร์กดาวน์อย่างมีประสิทธิภาพและประสิทธิผล
  • การฝังเนื้อหาแบบริชมีเดีย: ฝังเนื้อหาเว็บภายนอก เช่น วิดีโอ ข้อมูลโค้ด บทความ เพลง และอื่นๆ
  • แดชบอร์ดสำหรับนักเขียน: มีแดชบอร์ดอัจฉริยะสำหรับนักเขียนที่รองรับการแก้ไขภาพ
  • แบบร่าง: ร่างการเปลี่ยนแปลงใหม่และทำงานร่วมกันแบบไม่พร้อมกัน
  • ความคิดเห็นสนับสนุน: พูดคุยและตรวจสอบการเปลี่ยนแปลงฉบับร่าง
  • ติดตามประวัติการเขียน: ติดตามทุกอย่าง ตรวจสอบและเปลี่ยนกลับการเปลี่ยนแปลง
  • ข้อมูลเชิงลึก: รวมถึงรองรับข้อมูลเชิงลึกที่ติดตามการเข้าชม การให้คะแนน และคุณภาพของเนื้อหา
  • การซิงค์ 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 ขององค์กรและสร้างที่เก็บสำหรับ "คู่มือ" เช่น chaoss-handbook
  • ตอนนี้ ให้เลือกที่เก็บชื่อ chaoss-handbook ที่ต้องการเชื่อมต่อภายในตัวเลือกการให้สิทธิ์ภายในแพลตฟอร์ม GitBook

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

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

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

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

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

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

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

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

ตัวอย่างรูปภาพ: 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/
  • เอกสาร Bridge ชุมชนของ Linux Foundation - https://docs.linuxfoundation.org/docs/ และอื่นๆ อีกมากมาย

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

1.) ช่วงสานสัมพันธ์ของชุมชน (17 ส.ค. - 13 ก.ย.)

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

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

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

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

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

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

  • ร่างส่วน "แนวทางของชุมชน CHAOSS"

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 พ.ย.)

  • ร่างเกี่ยวกับหลักเกณฑ์ของ Outreachy

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

  • ระยะเวลากันชน ขัดเกลาและปรับปรุงเอกสารทั้งฉบับ

3.) ระยะการประเมิน (30 พ.ย. - 5 ธ.ค.)

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

  • ร่างรายงานโปรเจ็กต์
  • กรอกข้อมูลการประเมินโปรเจ็กต์

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

1.) การมีส่วนร่วมและการสนทนากับชุมชน

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

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

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

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

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

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

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

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

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

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

4.) คุณจะทําอย่างไรหากติดขัดกับโปรเจ็กต์และที่ปรึกษาไม่อยู่

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

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

นอกจากนี้ เรายังพยายามเข้าร่วมการโทรขอความช่วยเหลือรายสัปดาห์ภายในชุมชน CHAOSS เพื่อสอบถามข้อสงสัยด้วย