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