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