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