พื้นที่เก็บข้อมูลนี้เก็บซอร์สโค้ดสำหรับเอกสารประกอบของผู้สร้างที่ create.roblox.com/docs
หมายเหตุ : ปัจจุบัน พื้นที่เก็บข้อมูลมีคำแนะนำ บทช่วยสอน เนื้อหาด้านการศึกษา และการอ้างอิง Engine API ตัวอย่างโค้ดจะมาเร็วๆ นี้
หากคุณไม่คุ้นเคยกับกระบวนการสนับสนุน GitHub โปรดดูเกี่ยวกับคำขอดึงและวิดีโอต่อไปนี้
หากคุณพบปัญหาเกี่ยวกับเอกสารประกอบและไม่ต้องการส่งคำขอดึง โปรดแจ้งให้เราทราบโดยการรายงานในฟอรัมนักพัฒนา Roblox
การเพิ่มใดๆ ในเอกสารประกอบของผู้สร้าง Roblox จะต้องพอดีกับส่วนรวมที่ใหญ่กว่า กล่าวอีกนัยหนึ่ง แม้แต่โพสต์บนบล็อกหรือเอกสารทางเทคนิคที่ครบถ้วน ถูกต้อง และเขียนมาอย่างดีก็อาจไม่มีประโยชน์บนเว็บไซต์
โดยทั่วไปแล้ว เรามองหาเนื้อหาที่สอดคล้องกับมาตรฐานที่มีอยู่ของเรา และนำไปใช้กับประสบการณ์และกรณีการใช้งานที่หลากหลาย ตัวอย่างเช่น เราชอบหน้าต่างๆ เช่น การสร้างอินเทอร์เฟซผู้ใช้ มากกว่าหน้าเช่น การสร้างมาตรวัดความเร็วสำหรับเกมแข่งรถ ลองโพสต์คำแนะนำพิเศษเพิ่มเติมในฟอรัมนักพัฒนา Roblox
เมื่อคุณส่งคำขอดึงข้อมูลเพื่อรับการตรวจสอบ คุณต้องยอมรับสิ่งต่อไปนี้:
การบริจาคนี้สร้างขึ้นทั้งหมดหรือบางส่วนโดยฉัน และฉันมีสิทธิ์ที่จะส่งภายใต้เงื่อนไขของใบอนุญาตโอเพ่นซอร์สของพื้นที่เก็บข้อมูลนี้
ฉันเข้าใจและยอมรับว่าการสนับสนุนนี้และบันทึกของสิ่งนี้เป็นแบบสาธารณะ ได้รับการดูแลโดยไม่มีกำหนด และอาจแจกจ่ายต่อได้ภายใต้เงื่อนไขของใบอนุญาตโอเพ่นซอร์สของพื้นที่เก็บข้อมูลนี้
เท่าที่ฉันทราบ การเปลี่ยนแปลงที่เสนอทั้งหมดมีความถูกต้อง
สำหรับการเปลี่ยนแปลงง่ายๆ ที่แตะไฟล์เดียวเท่านั้น ให้ใช้โปรแกรมแก้ไขบนเว็บของ GitHub:
ค้นหาไฟล์ใน content/en-us/ แล้วคลิก แก้ไขไฟล์นี้
คลิก แยกที่เก็บนี้
ทำการเปลี่ยนแปลงแล้วคลิก ยอมรับการเปลี่ยนแปลง...
ส่งข้อความยืนยันการเปลี่ยนแปลงของคุณแล้วคลิก เสนอการเปลี่ยนแปลง
ตรวจสอบให้แน่ใจว่าที่เก็บฐานคือ Roblox/creator-docs และสาขาฐานเป็น main ตรวจสอบว่าคุณพอใจกับการเปลี่ยนแปลงแล้วคลิก สร้างคำขอดึง
สุดท้าย กรอกรายละเอียดในคำอธิบายคำขอดึง และคลิก สร้างคำขอดึง
สำหรับการเปลี่ยนแปลงขนาดใหญ่ที่เกี่ยวข้องกับไฟล์หลายไฟล์ เราขอแนะนำ github.dev ซึ่งเป็นโปรแกรมแก้ไขข้อความที่มีคุณสมบัติครบถ้วนมากขึ้นโดยยึดตาม Visual Studio Code ที่ทำงานบนเบราว์เซอร์ของคุณ:
แยกพื้นที่เก็บข้อมูล
ขณะเรียกดูส้อมของคุณ ให้กด ปุ่ม กุญแจสำคัญในการเปิด github.dev
ในเมนู การควบคุมแหล่ง ที่มา คลิก ... > สาขา > สร้างสาขา...
ตั้งชื่อสาขาแล้วคลิก สลับไปที่สาขา
ใช้เมนู Explorer เพื่อค้นหาไฟล์ที่คุณต้องการอัปเดตใน content/en-us และทำการเปลี่ยนแปลงตามที่คุณต้องการ
ในเมนู การควบคุมแหล่ง ที่มา ตรวจสอบว่าคุณพอใจกับการเปลี่ยนแปลงของคุณ
เพิ่มข้อความคอมมิตแล้วคลิก คอมมิตและพุช
ในแท็บเบราว์เซอร์ใหม่ ให้ไปที่ github.com/Roblox/creator-docs
คลิก เปรียบเทียบและดึงคำขอ
ตรวจสอบว่าที่เก็บฐานคือ Roblox/creator-docs และสาขาฐานเป็น main ที่เก็บส่วนหัวควรเป็นทางแยกและสาขาของคุณ
สุดท้าย กรอกรายละเอียดในคำอธิบายคำขอดึง และคลิก สร้างคำขอดึง
หรือคุณสามารถใช้เมนู คำขอดึง GitHub หรือ GitHub ใน github.dev เพื่อส่งคำขอดึง สำหรับเอกสารประกอบเกี่ยวกับการใช้ github.dev โปรดดู GitHub Codespaces
พื้นที่เก็บข้อมูลนี้มีขนาดใหญ่มาก ดังนั้นเราขอแนะนำให้ใช้ตัวเลือกออนไลน์ทุกครั้งที่เป็นไปได้ อย่างไรก็ตาม หากคุณคุ้นเคยกับเวิร์กโฟลว์ GitHub ทั่วไปอยู่แล้ว และต้องการใช้โปรแกรมแก้ไขข้อความแบบออฟไลน์ ต่อไปนี้เป็นขั้นตอนพื้นฐานในการร่วมให้ข้อมูลในเอกสารประกอบ:
ตั้งค่า Git และ Git LFS หรือติดตั้งไคลเอนต์ Git เช่น GitHub Desktop
แยกที่เก็บนี้
โคลนส้อมของคุณ
นำทางไปยังรูทของที่เก็บ
สร้างสาขาใหม่
ทำการเปลี่ยนแปลงตามที่คุณต้องการ
คอมมิต พุชไปที่ Fork ของคุณ และส่งคำขอดึงของคุณไปยังสาขา main ของที่เก็บนี้
สำหรับขั้นตอนโดยละเอียดเพิ่มเติม โปรดดูที่ CONTRIBUTING.md
เอกสาร Roblox มีเอกสารหลักสามประเภท:
คำแนะนำเชิงแนวคิดและตามงานในไฟล์ .md ในเนื้อหา/en-us/
คำแนะนำจะสอนคุณเกี่ยวกับฟีเจอร์หรือเวิร์กโฟลว์โดยไม่ต้องกำหนดผลลัพธ์สุดท้ายมากเกินไป โดยจะแนะนำแนวคิดและคุณลักษณะต่างๆ และครอบคลุมงานที่คุณสามารถทำได้โดยใช้เครื่องมือต่างๆ หรือแนวทางอื่นๆ
คำแนะนำจะได้รับประโยชน์อย่างมากจากกรณีการใช้งานจริง รูปภาพ ข้อมูลโค้ด และไดอะแกรม เนื้อหาตามงานส่วนใหญ่ควรมีรายการลำดับเลข
เอกสารอ้างอิง API ในไฟล์ .yaml ใน content/en-us/reference
API เป็นเนื้อหาอ้างอิงทั้งหมด และควรใช้คำอธิบายการทำงาน โดยลิงก์ไปยังคำแนะนำตามความเหมาะสม มากกว่าเนื้อหาประเภทอื่นๆ เนื้อหาอ้างอิงควรกระชับและตรงประเด็น ข้อมูลสรุปสำหรับคุณสมบัติ วิธีการ เหตุการณ์ และการเรียกกลับไม่จำเป็นต้องเป็นประโยคที่สมบูรณ์
บทช่วยสอนในไฟล์ .md ในเนื้อหา/en-us/tutorials
เมื่อเปรียบเทียบกับคำแนะนำตามงานแล้ว บทช่วยสอนมีความสมบูรณ์ในตัวเองมากกว่าและพาคุณจาก ไม่มีอะไร ไปสู่ บางสิ่ง การมุ่งเน้นที่การสร้างสิ่งที่เฉพาะเจาะจงหมายความว่าโดยทั่วไปแล้วสิ่งเหล่านั้นมีการกำหนดไว้มากกว่าคำแนะนำ บทช่วยสอนมักจะพูดถึงคุณสมบัติและแนวคิดหลายอย่างในเวลาเดียวกัน ซึ่งแสดงให้เห็นถึงความเชื่อมโยงระหว่างเครื่องมือและกลยุทธ์
หากการมีส่วนร่วมของคุณไม่ตรงกับหมวดหมู่เหล่านี้หรือครอบคลุมหัวข้อที่แคบเป็นพิเศษ ก็อาจไม่เหมาะกับเอกสารประกอบ ลองโพสต์ไปที่ฟอรัมนักพัฒนา Roblox
พยายามจำกัดการแก้ไขของคุณไว้ที่คลาสหรือฟีเจอร์เดียว เพื่อให้คำขอดึงตรวจสอบได้ง่ายขึ้น การแก้ไขข้อบกพร่องและการปรับปรุงเล็กๆ น้อยๆ มีโอกาสสูงที่จะได้รับการอนุมัติอย่างรวดเร็ว คู่มือขนาดใหญ่มักต้องมีการกลับไปกลับมาอย่างมีนัยสำคัญก่อนที่จะตีพิมพ์
เพื่อหลีกเลี่ยงปัญหาการจัดรูปแบบ เราขอแนะนำโปรแกรมแก้ไขข้อความ เช่น github.dev ที่ให้คุณดูตัวอย่าง Markdown ขณะที่คุณเขียนได้ สำหรับร้อยแก้ว ให้ลองปฏิบัติตามหลักเกณฑ์ใน STYLE.md สำหรับตัวอย่างโค้ด ให้ใช้ Lua Style Guide
หากต้องการดูหน้าที่จัดรูปแบบอย่างสมบูรณ์ตามสิ่งที่เราเห็นในสาขา main ให้แทนที่ URL ทั้งหมดจาก content/ และก่อนหน้านี้ ไฟล์ที่มี index ชื่อฐานควรลบชื่อนั้นออก ตัวอย่างเช่น หน้าสำหรับ "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" แสดงผลที่ "https://create.roblox.com /docs/en-us/avatar"
สำหรับร้อยแก้ว โครงการนี้ใช้ Creative Commons Attribution 4.0 International Public License สำหรับข้อความลิขสิทธิ์ฉบับเต็ม โปรดดูที่ LICENSE
ตัวอย่างโค้ดมีให้ใช้งานภายใต้ใบอนุญาต MIT สำหรับข้อความลิขสิทธิ์ฉบับเต็ม โปรดดูที่ LICENSE-CODE
เพื่อรักษาชุมชนที่เปิดกว้าง เป็นมิตร มีความหลากหลาย ไม่แบ่งแยก และมีสุขภาพดี โครงการนี้จึงบังคับใช้ข้อตกลงผู้สนับสนุนฉบับดัดแปลง สำหรับข้อมูลเพิ่มเติม โปรดดู CODE_OF_CONDUCT.md
