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