ขอขอบคุณที่มีส่วนร่วมในเอกสารประกอบของ Bazel การสร้างเอกสารที่ดีขึ้นสําหรับชุมชนของเรามีหลายวิธี
ประเภทเอกสาร
เว็บไซต์มีเนื้อหา 2-3 ประเภท
- เอกสารประกอบการบรรยาย ซึ่งเขียนโดยนักเขียนและวิศวกรทางเทคนิค เว็บไซต์นี้ส่วนใหญ่เป็นเอกสารประกอบการบรรยายที่ครอบคลุมคําแนะนําเชิงแนวคิดและงานที่ต้องทํา
- เอกสารอ้างอิง ซึ่งสร้างขึ้นจากเอกสารแสดงความคิดเห็น คุณจะเปลี่ยนแปลงหน้าเอกสารอ้างอิงโดยตรงไม่ได้ แต่จําเป็นต้องเปลี่ยนแหล่งที่มา
โครงสร้างพื้นฐานเอกสารประกอบ
เอกสารประกอบของ Bazel จะแสดงจาก Google และไฟล์ต้นฉบับมิเรอร์ในที่เก็บ GitHub ของ Bazel คุณเปลี่ยนแปลงไฟล์ต้นฉบับใน GitHub ได้ หากได้รับอนุมัติ คุณจะรวมการเปลี่ยนแปลงได้ และผู้ดูแล Bazel จะอัปเดตแหล่งที่มาของเว็บไซต์เพื่อเผยแพร่การอัปเดต
การเปลี่ยนแปลงเพียงเล็กน้อย
คุณสามารถจัดการการเปลี่ยนแปลงเพียงเล็กน้อยได้ เช่น แก้ไขข้อผิดพลาดหรือพิมพ์ผิด 2-3 วิธี
- คําขอดึง คุณสร้างคําขอดึงข้อมูลใน GitHub ได้ด้วยเครื่องมือแก้ไขบนเว็บหรือในสาขา
- ข้อบกพร่อง คุณรายงานข้อบกพร่องพร้อมรายละเอียดและการเปลี่ยนแปลงที่แนะนําได้ และเจ้าของเอกสาร Bazel จะเป็นผู้อัปเดต
การเปลี่ยนแปลงจํานวนมาก
หากต้องการเปลี่ยนแปลงเอกสารประกอบที่มีอยู่เป็นจํานวนมากหรือเสนอเอกสารประกอบใหม่ ให้สร้างคําขอดึงข้อมูลหรือเริ่มต้นด้วยเอกสารของ Google และติดต่อเจ้าของ Bazel เพื่อทํางานร่วมกัน