กระบวนการเขียนคู่มือ

เรียนรู้เพิ่มเติมเกี่ยวกับกระบวนการส่งเนื้อหาให้กับ ZAP-Docs ของเราบนหน้านี้ กระบวนการจะถูกเขียนตามลำดับเวลาในหน้านี้ ดังนั้นเราขอแนะนำให้เริ่มต้นจากตรงนี้

ขั้นตอนที่ 1: เสนอเนื้อหา

ส่วนแรกของกระบวนการคือการสร้าง issue เสนอไอเดียผ่าน GitHub repository ของเรา คุณต้องให้รายละเอียดเกี่ยวกับการเปลี่ยนแปลงและการปรับปรุงที่คุณวางแผนจะทำ

โปรดตรวจสอบให้แน่ใจว่าไอเดียของคุณไม่ซ้ำกับคู่มือหรือข้อเสนอที่มีอยู่แล้ว และคุณเชื่ออย่างลึกซึ้งว่าจะเป็นประโยชน์สำหรับผู้เริ่มต้นหรือผู้ใช้ที่มีประสบการณ์มากขึ้น คุณสามารถดูข้อเสนอที่มีอยู่ได้ที่ หน้า Issues

เคล็ดลับ

เราแนะนำให้คุณอ่าน แนวทาง ของเราเพื่อเข้าใจสไตล์เนื้อหาและเอกสารที่เราต้องการ

เรากำลังมองหาเรื่องอะไร?

ในคู่มือของเรา เรามองหาคู่มือที่ใช้งานได้จริงและมีคุณภาพสูงครอบคลุมผลิตภัณฑ์ บริการ และซอฟต์แวร์โอเพ่นซอร์สที่มีให้ผ่าน ZAP-Hosting หรือเกี่ยวข้องกับบริการใด ๆ ที่เรามี หากคุณต้องการไอเดียหรือแรงบันดาลใจ ลองดูหน้าเว็บของเราใน ZAP-Docs เพื่อสัมผัสสไตล์การเขียนและประเภทเนื้อหาที่เรานำเสนอ

อย่างที่กล่าวไว้ในบทนำ เนื้อหาทั้งหมดที่สร้างขึ้นต้องเป็นต้นฉบับเพื่อให้สอดคล้องกับกฎหมายลิขสิทธิ์ ห้ามใช้ AI/เครื่องมือสร้างเนื้อหาอัตโนมัติหรือทรัพย์สินทางปัญญาอื่น ๆ โดยไม่ได้รับอนุญาต คู่มือของเรามุ่งเน้นให้ข้อมูลคุณภาพสูงผ่านขั้นตอนต่าง ๆ เพื่อให้ผู้อ่านเข้าใจสิ่งที่ทำและวิธีทำ พร้อมเป้าหมายสุดท้ายคือการให้ความรู้และแก้ปัญหาให้ผู้อ่าน

รายการคู่มือที่ต้องการ

เรามีรายการข้อเสนอที่น่าสนใจสำหรับคู่มือใหม่ ๆ ที่คุณอาจสนใจเขียน บางหัวข้อคู่มือและข้อเสนออาจมีโบนัสรางวัลพิเศษ คุณสามารถเข้าถึง รายการนี้ด้วยตนเองที่นี่

บันทึก

โปรดจำไว้ว่า นี่เป็นเพียงไอเดียที่มีประโยชน์เท่านั้น คุณ ไม่จำเป็น ต้องเขียนตามนี้อย่างเคร่งครัด ข้อเสนอคู่มือของคุณสามารถสร้างสรรค์ได้ตามที่กล่าวไว้ก่อนหน้านี้

การส่งข้อเสนอ

เมื่อคุณมั่นใจว่าไอเดียของคุณเหมาะสมกับเอกสารของเราแล้ว กรุณาไปที่ ZAP Docs GitHub repository และเปิด issue โดยใช้เทมเพลต Contribution Suggestion โปรดทำตามเทมเพลตที่ให้มาและกรอกข้อมูลที่จำเป็นทั้งหมด คุณจะถูกขอให้ยืนยันว่าคุณยอมรับข้อกำหนดและเงื่อนไขของโปรแกรมการมีส่วนร่วม ซึ่งสามารถดูได้ที่ Contribution Terms

คำเตือน

โปรดตรวจสอบให้แน่ใจว่าคุณกรอก ZAP ID ของคุณถูกต้องเพื่อให้ได้รับรางวัลไปยังบัญชีที่ถูกต้อง!

หลังจากส่งข้อเสนอแล้ว เราจะพยายามตอบกลับภายใน 3-5 วัน คุณจะได้รับการตอบกลับโดยตรงใน GitHub issue ของคุณ

เคล็ดลับ

เจอปัญหาอะไรไหม? เข้าร่วม เซิร์ฟเวอร์ Discord ของ ZAP-Hosting ได้เลย ที่นั่นทั้งทีมงานและชุมชน ZAP พร้อมช่วยเหลือคุณ หรือจะติดต่อผ่าน ตั๋วบนเว็บไซต์ของเรา โดยระบุข้อความว่า "Contribution Program - Guides" เพื่อส่งต่อไปยังทีมงาน Contributions ของ ZAP-Hosting

ในการตอบกลับ เราจะให้คำติชมเพิ่มเติมหรือรายละเอียดที่ต้องการปรับแก้เกี่ยวกับข้อเสนอของคุณ หากมีปัญหา เราจะติดตามโดยตรงใน GitHub issue ของคุณ

ขั้นตอนที่ 2: การเขียนคู่มือ

เมื่อทำการเพิ่มหรือแก้ไขเอกสาร โปรดตรวจสอบให้แน่ใจว่าคุณปฏิบัติตาม แนวทาง อย่างละเอียดเพื่อความสม่ำเสมอและคุณภาพสูง ในส่วนนี้เราจะเจาะลึกแนวทางปฏิบัติที่ดีที่สุดและวิธีการทำงานที่เหมาะสมสำหรับการสร้างเนื้อหาใหม่ รวมถึงการแก้ไขเนื้อหาที่มีอยู่ หากคุณยังใหม่กับ GitHub โปรดใช้บทเรียนสั้น ๆ ด้านล่างเพื่อเข้าใจวิธีแก้ไขหรือสร้างเนื้อหาใหม่สำหรับ ZAP-Docs ของเราได้ง่ายที่สุด

บันทึก

ตรวจสอบให้แน่ใจว่าคุณได้สร้างข้อเสนอใน GitHub Repository และได้รับการอนุมัติจากสมาชิกทีม ZAP Contribution ก่อนเริ่มทำคู่มือหรือแก้ไขใด ๆ เราจะไม่สามารถรับประกันรางวัลได้หากคุณไม่ได้ทำตามกระบวนการและไม่ได้รับการอนุมัติ

สิ่งที่ต้องมี:

• บัญชี GitHub

ขั้นตอนแรกคือการสร้าง fork ของ repository ZAP-Docs จาก GitHub คุณสามารถทำได้โดยไปที่ ZAP Docs GitHub repository แล้วกดปุ่ม Fork ที่ด้านบนของหน้า

คุณควรตั้งชื่อ repository ตามข้อเสนอที่ได้รับการอนุมัติ และติ๊กเลือก Copy the master branch only จากนั้นกดปุ่มสร้างและรอสักครู่จน fork เสร็จสมบูรณ์

เมื่อคุณมี fork ของตัวเองแล้ว คุณสามารถดำเนินการในส่วนถัดไปเพื่อทำงานของคุณได้ มีสองวิธีหลักในการสร้างเนื้อหา คือ ผ่านเว็บไซต์ GitHub โดยตรง หรือโคลน repository มาทำงานในเครื่อง วิธีแรกใช้งานง่ายกว่า ส่วนวิธีที่สองช่วยให้คุณทดสอบ Docusaurus แบบสด ๆ ได้ก่อน

เคล็ดลับ

สำหรับมือใหม่หรือคนที่ไม่ค่อยมีประสบการณ์กับ Git เราแนะนำให้ใช้ วิธีที่ 1 เพื่อเขียนเนื้อหา เพราะใช้งานง่ายกว่า เร็วกว่า และทำผ่านเว็บเบราว์เซอร์บนเว็บไซต์ GitHub ได้เลย วิธีนี้ไม่ต้องตั้งค่าอะไรในเครื่องเลย

วิธีการสร้างคู่มือ

วิธีที่ 1: ผ่านเว็บไซต์ GitHub โดยตรง

วิธีที่ง่ายและแนะนำที่สุดในการสร้างเนื้อหาคือทำผ่านเว็บไซต์ GitHub ในส่วนนี้เราจะแสดงวิธีสร้างคู่มือใหม่และแก้ไขคู่มือที่มีอยู่ผ่านเว็บไซต์ GitHub

เริ่มต้นโดยไปที่ Fork ที่คุณสร้างไว้ในขั้นตอนก่อนหน้า เมื่ออยู่ใน Fork ของ ZAP Docs คุณสามารถเข้าถึงคู่มือทั้งหมดได้ในโฟลเดอร์ docs

ไฟล์เอกสารจะตั้งชื่อแบบง่าย ๆ โดยคำแรกจะบอกประเภทคู่มือ เช่น เกม ผลิตภัณฑ์ หรือหมวดหมู่ และคำถัดไปจะบอกส่วนเฉพาะ เราแนะนำให้ดูเว็บไซต์ ZAP-Docs เวอร์ชันสด เพื่อค้นหาพื้นที่ที่คู่มือควรอยู่ เช่น dedicated-windows.md หมายถึงส่วนเซิร์ฟเวอร์เฉพาะสำหรับระบบปฏิบัติการ Windows

ตอนนี้คุณจะต้องเปิดไฟล์คู่มือที่มีอยู่แล้วหรือสร้างไฟล์ใหม่ ขึ้นอยู่กับว่าคุณจะอัปเดตคู่มือหรือสร้างใหม่ ใช้แท็บที่เหมาะสมด้านล่างเพื่อดูคำแนะนำ เพราะคู่มือใหม่ต้องเตรียมไฟล์เพิ่มอีกเล็กน้อย

สร้างไฟล์คู่มือใหม่

ในตัวอย่างนี้ ข้อเสนอของเราคือสร้างคู่มือใหม่สำหรับเกม Rust โดยเฉพาะเกี่ยวกับคำสั่งที่เกมมี จากการตรวจสอบเว็บไซต์ ZAP-Docs และ repository เราจะเห็นว่ามีส่วน Rust อยู่แล้วในหมวดหมู่เซิร์ฟเวอร์เกม ตามรูปแบบการตั้งชื่อและคู่มือที่มีอยู่ เราสามารถตั้งชื่อไฟล์ใหม่ว่า rust-commands.md

ตอนนี้เพื่อสร้างไฟล์ใหม่ ให้ไปที่ GitHub Repository เปิดโฟลเดอร์ docs และที่ด้านขวาของหน้าจอ เลือก Add File ในเมนู ให้กด Create new file ซึ่งจะเปิดแท็บใหม่

ที่ด้านบนของหน้าในไดเรกทอรีไฟล์ คุณสามารถตั้งชื่อไฟล์ได้ ตามที่เรากำหนดไว้ก่อนหน้านี้ ในตัวอย่างนี้คือ rust-commands.md

ข้อมูล

โปรดตรวจสอบให้แน่ใจว่าเพิ่มนามสกุล .md เพราะคู่มือทั้งหมดเป็นฟอร์แมต Markdown

ส่วนถัดไปคือการเพิ่ม metadata สำคัญที่ส่วนต้นของไฟล์ วิธีที่ง่ายที่สุดคือเปิดไฟล์อื่น เช่น rust-plugins.md แล้วคัดลอกแท็ก metadata ด้านบนมา จากนั้นปรับค่าแต่ละตัวให้ตรงกับคู่มือใหม่ โดยเฉพาะอย่างยิ่งฟิลด์ id ที่ ต้อง ตรงกับชื่อไฟล์ (ไม่รวม .md)

ในตัวอย่างของเรา ไฟล์ควรมีเนื้อหาดังนี้:

---
id: rust-commands
title: "Rust: Admin Commands"
description: "ข้อมูลคำสั่ง Admin สำหรับ Rust จาก ZAP-Hosting"
sidebar_label: Admin Commands
services:
  - gameserver
---

บันทึก

เราจะตรวจสอบ metadata อีกครั้งในขั้นตอนรีวิว ดังนั้นไม่ต้องกังวลหากคุณเจอปัญหา ให้ดำเนินการต่อไปได้เลย

แก้ไขไฟล์คู่มือที่มีอยู่

ในกรณีนี้ คุณต้องเปิดไฟล์เป้าหมายที่ต้องการแก้ไข ในตัวอย่างนี้เราจะใช้ dedicated-linux-satisfactory.md ซึ่งอยู่ในโฟลเดอร์ /docs ของ repository เมื่อเปิดไฟล์แล้ว คุณจะเห็นตัวอย่างคร่าว ๆ ของเนื้อหาตาม Markdown

ไปที่มุมบนขวาของไฟล์แล้วกดไอคอนแก้ไข (รูปปากกา) ซึ่งจะเปิดแท็บใหม่ให้คุณแก้ไขไฟล์ได้โดยตรง

ต่อไป: การสร้างเนื้อหา

เมื่อคุณเตรียมและเปิดไฟล์เรียบร้อยแล้ว คุณสามารถเริ่มเขียนเนื้อหาตามที่ตกลงไว้ในข้อเสนอ เราแนะนำให้บันทึกหรือ commit เป็นระยะ ๆ เพื่อป้องกันการสูญเสียงาน

เก็บงานของคุณให้ปลอดภัย

ขณะเขียนเนื้อหา โปรด commit หรือสำรองข้อมูลบ่อย ๆ เพราะตัวแก้ไขบน GitHub ไม่มีฟังก์ชัน auto-save หากคุณปิดแท็บเบราว์เซอร์หรือเกิดเหตุไม่คาดฝัน คุณอาจสูญเสียงานได้

เรา แนะนำอย่างยิ่ง ให้ใช้เครื่องมือ Markdown อย่าง StackEdit เพื่อเขียนเนื้อหา เพราะช่วยให้คุณเก็บงานไว้ในเครื่องและซิงค์กับไดรฟ์หรือบัญชีต่าง ๆ ได้ เมื่อเสร็จแล้วก็แค่คัดลอกเนื้อหาไปวางในไฟล์บนเว็บไซต์ GitHub แล้ว commit

คุณสามารถใช้ปุ่ม Preview ที่ด้านบนของหน้าต่างแก้ไขเพื่อสลับไปดูตัวอย่าง และกลับมาแก้ไขอีกครั้งด้วยปุ่ม Edit

องค์ประกอบ Docusaurus

โปรดทราบว่าองค์ประกอบเฉพาะของ Docusaurus เช่น admonitions (แท็กอย่าง :::note, :::tip ฯลฯ) หรือแท็บ อาจไม่แสดงผลถูกต้องเมื่อดูตัวอย่างผ่าน GitHub เพราะไม่ใช่ Markdown แบบดั้งเดิม แต่จะแสดงผลถูกต้องเมื่อทดสอบในเครื่องและในโปรดักชัน

ปฏิบัติตามแนวทางของเรา

โปรดดู แนวทาง สำหรับข้อมูลทั้งหมดเกี่ยวกับ Markdown โครงสร้าง คำศัพท์ และอื่น ๆ

เมื่อคุณแก้ไขเสร็จแล้ว ให้กดปุ่ม Commit changes... ซึ่งจะมีหน้าต่างแจ้งเตือนขึ้นมา

กรอกข้อความ commit ที่อธิบายสิ่งที่คุณทำ และคำอธิบายเพิ่มเติมถ้าจำเป็น จากนั้น commit การเปลี่ยนแปลง ซึ่งจะ commit ไปยัง fork ของคุณ คุณสามารถไปที่ส่วน Submitting Content เพื่อสร้าง Pull Request ส่งเนื้อหาไปยัง ZAP-Docs Repository หลักได้เลย

วิธีที่ 2: ทำงานในเครื่องผ่าน IDE (git cloning)

คุณอาจชอบเขียนเนื้อหาในเครื่องผ่าน IDE หรือ editor เช่น Visual Studio Code ในส่วนนี้เราจะแสดงวิธีสร้างคู่มือใหม่และแก้ไขคู่มือที่มีอยู่ในเครื่องผ่าน editor

สิ่งที่ต้องมี:

• IDE ที่คุณชอบ ในตัวอย่างนี้ใช้ Visual Studio Code
• GitHub Desktop (หรือโปรแกรมที่มีฟังก์ชัน Git)

ขั้นตอนแรกคือโคลน repository fork ของคุณ วิธีที่ง่ายและใช้งานง่ายที่สุดคือใช้ GitHub Desktop โดยเลือก Add แล้วเลือก Clone repository และเลือก repository fork ของคุณ หรือจะทำผ่าน IDE ที่มีฟังก์ชัน Git ก็ได้

จากนั้นเปิดโฟลเดอร์ repository ใน Visual Studio Code ที่แท็บ Explorer ด้านซ้าย คุณจะเห็นโฟลเดอร์ทั้งหมดใน repository

ไฟล์เอกสารตั้งชื่อแบบง่าย ๆ โดยคำแรกบอกประเภทคู่มือ เช่น เกม ผลิตภัณฑ์ หรือหมวดหมู่ และคำถัดไปบอกส่วนเฉพาะ เราแนะนำให้ดูเว็บไซต์ ZAP-Docs เวอร์ชันสด เพื่อค้นหาพื้นที่ที่คู่มือควรอยู่ เช่น dedicated-windows.md หมายถึงส่วนเซิร์ฟเวอร์เฉพาะสำหรับระบบปฏิบัติการ Windows

ตอนนี้คุณจะต้องเปิดไฟล์คู่มือที่มีอยู่แล้วหรือสร้างไฟล์ใหม่ ขึ้นอยู่กับว่าคุณจะอัปเดตคู่มือหรือสร้างใหม่ ใช้แท็บที่เหมาะสมด้านล่างเพื่อดูคำแนะนำ เพราะคู่มือใหม่ต้องเตรียมไฟล์เพิ่มอีกเล็กน้อย

สร้างไฟล์คู่มือใหม่

ในตัวอย่างนี้ ข้อเสนอของเราคือสร้างคู่มือใหม่สำหรับเกม Rust โดยเฉพาะเกี่ยวกับคำสั่งที่เกมมี จากการตรวจสอบเว็บไซต์ ZAP-Docs และ repository เราจะเห็นว่ามีส่วน Rust อยู่แล้วในหมวดหมู่เซิร์ฟเวอร์เกม ตามรูปแบบการตั้งชื่อและคู่มือที่มีอยู่ เราสามารถตั้งชื่อไฟล์ใหม่ว่า rust-commands.md

เปิดโฟลเดอร์ /docs ใน IDE ของคุณและสร้างไฟล์ใหม่โดยใช้ชื่อตามคู่มือใหม่ของคุณ

ข้อมูล

โปรดตรวจสอบให้แน่ใจว่าเพิ่มนามสกุล .md เพราะคู่มือทั้งหมดเป็นฟอร์แมต Markdown

ส่วนถัดไปคือการเพิ่ม metadata สำคัญที่ส่วนต้นของไฟล์ วิธีที่ง่ายที่สุดคือเปิดไฟล์อื่น เช่น rust-plugins.md แล้วคัดลอกแท็ก metadata ด้านบนมา จากนั้นปรับค่าแต่ละตัวให้ตรงกับคู่มือใหม่ โดยเฉพาะอย่างยิ่งฟิลด์ id ที่ ต้อง ตรงกับชื่อไฟล์ (ไม่รวม .md)

ในตัวอย่างของเรา ไฟล์ควรมีเนื้อหาดังนี้:

---
id: rust-commands
title: "Rust: Admin Commands"
description: "ข้อมูลคำสั่ง Admin สำหรับ Rust จาก ZAP-Hosting"
sidebar_label: Admin Commands
services:
  - gameserver
---

บันทึก

เราจะตรวจสอบ metadata อีกครั้งในขั้นตอนรีวิว ดังนั้นไม่ต้องกังวลหากคุณเจอปัญหา ให้ดำเนินการต่อไปได้เลย

ขั้นตอนสุดท้ายเพื่อให้หน้าใหม่ของคุณแสดงใน sidebar ของ Docusaurus คือเพิ่มไฟล์นี้ในไฟล์ sidebar.js ในส่วนที่ถูกต้อง เพราะส่วน Rust มีอยู่แล้ว คุณสามารถหาได้โดยกด CTRL+F แล้วค้นหาคำว่า rust

ใต้รายการสุดท้าย ให้สร้างบรรทัดใหม่แล้วใส่ชื่อไฟล์ของคุณ ในตัวอย่างนี้คือ rust-commands หากยังไม่มีส่วนที่เหมาะสม คุณสามารถเพิ่มส่วนใหม่ตามรูปแบบของส่วนอื่น ๆ ได้เลย

บันทึก

อย่าลืมใส่เครื่องหมายจุลภาค (,) ที่บรรทัดก่อนหน้าบรรทัดใหม่ของคุณเพื่อให้ไวยากรณ์ถูกต้อง

แก้ไขไฟล์คู่มือที่มีอยู่

การแก้ไขไฟล์ที่มีอยู่ทำได้ง่ายมาก เพราะคุณไม่ต้องตั้งค่าโครงสร้างไฟล์ทั้งหมด

แค่เปิดไฟล์คู่มือเป้าหมายที่ต้องการแก้ไขในโฟลเดอร์ /docs แล้วเริ่มแก้ไขตามข้อเสนอที่ได้รับการอนุมัติ

ต่อไป: การสร้างเนื้อหา

เมื่อไฟล์พร้อมแล้ว คุณสามารถเริ่มเขียนเนื้อหาตามที่ตกลงไว้ในข้อเสนอ เราแนะนำให้บันทึกหรือ commit เป็นระยะ ๆ เพื่อป้องกันการสูญเสียงาน

คุณสามารถใช้ทางลัด CTRL+SHIFT+V หรือกดไอคอน preview ที่มุมบนขวาของ editor เพื่อแยกหน้าจอใน IDE ซึ่งจะแสดงผล Markdown แบบสด ๆ ขณะคุณแก้ไข

องค์ประกอบ Docusaurus

โปรดทราบว่าองค์ประกอบเฉพาะของ Docusaurus เช่น admonitions (แท็กอย่าง :::note, :::tip ฯลฯ) หรือแท็บ อาจไม่แสดงผลถูกต้องเมื่อดูตัวอย่างผ่าน GitHub เพราะไม่ใช่ Markdown แบบดั้งเดิม แต่จะแสดงผลถูกต้องเมื่อทดสอบในเครื่องและในโปรดักชัน

ปฏิบัติตามแนวทางของเรา

โปรดดู แนวทาง สำหรับข้อมูลทั้งหมดเกี่ยวกับ Markdown โครงสร้าง คำศัพท์ และอื่น ๆ

เมื่อแก้ไขเสร็จ ขั้นตอนสุดท้ายของกระบวนการคือ push commit ไปยัง fork ของคุณและสร้าง Pull Request คุณสามารถสร้าง commit ผ่าน GitHub Desktop (หรือโปรแกรม Git อื่น ๆ) โดยใส่ชื่อและคำอธิบายที่เหมาะสมแล้วกดปุ่ม push ด้านบน

จากนั้นไปที่ส่วน Submitting Content เพื่อสร้าง Pull Request ส่งเนื้อหาไปยัง ZAP-Docs Repository หลักได้เลย

เคล็ดลับ

เราแนะนำให้อ่านส่วนเสริม ทดสอบ build ในเครื่อง ด้วย เพราะคุณสามารถจับคู่กับการทดสอบในเครื่องเพื่อสร้าง workflow ที่ดีที่สุด ที่จะอัปเดตการเปลี่ยนแปลงแบบสด ๆ ในเครื่องของคุณ ซึ่งมีประโยชน์มาก แต่ไม่จำเป็นต้องทำก็ได้

ตัวเลือกเสริม: ทดสอบ build ในเครื่อง

ก่อนสร้าง Pull Request สุดท้าย โดยทั่วไปควร build และทดสอบในเครื่องเพื่อให้แน่ใจว่าทุกอย่างทำงานถูกต้องกับการเปลี่ยนแปลงที่คุณทำ เราแนะนำให้ทดสอบในเครื่องเพื่อให้ Pull Request ของคุณได้รับการประมวลผลอย่างรวดเร็ว แต่ไม่จำเป็นต้องทำ คุณสามารถข้ามไปยังส่วนถัดไปได้ถ้าต้องการ

เคล็ดลับ

นี่ ไม่จำเป็น เพราะเราจะ build อัตโนมัติเมื่อคุณส่ง Pull Request แต่คุณอาจพบว่ามีประโยชน์สำหรับการดีบักและทดสอบแบบสดในเครื่อง

บันทึก

ถ้าคุณทำตามบทเรียนสร้างการเปลี่ยนแปลงในเครื่องแล้ว คุณสามารถข้ามขั้นตอนแรกที่เกี่ยวกับการโคลน repository ได้เลย เพราะคุณน่าจะมี repository อยู่แล้ว

สิ่งที่ต้องมี:

• Node.js v16.14 หรือสูงกว่า
• GitHub Desktop หรือ Git

ขั้นตอนแรกคือโคลน repository fork ของคุณ วิธีที่ง่ายและใช้งานง่ายที่สุดคือใช้ GitHub Desktop โดยเลือก Add แล้วเลือก Clone repository และเลือก repository fork ของคุณ

หรือจะใช้ Git ก็ได้ สร้างโฟลเดอร์ใหม่ เช่น Docs Test เข้าไปในโฟลเดอร์นั้นแล้วเปิด Git Bash (คลิกขวาแล้วเลือก Git Bash บน Windows) ไปที่ GitHub แล้วคัดลอก URL ของ fork คุณ จากนั้นรันคำสั่งนี้โดยแทนที่ [your_url] ด้วย URL fork ของคุณ:

git clone [your_url]

ตอนนี้คุณจะมี repository โคลนไว้ในเครื่องแล้วไม่ว่าจะใช้วิธีไหน ขั้นตอนถัดไปคือดาวน์โหลดโมดูลที่จำเป็นทั้งหมด เข้าไปในโฟลเดอร์ repository คลิกขวาแล้วเปิด cmd terminal (หรือใช้หน้าต่าง git) รันคำสั่งนี้เพื่อดาวน์โหลดโมดูลทั้งหมด:

npm install

อาจใช้เวลาสักครู่ เมื่อเสร็จจะมีโฟลเดอร์ node_modules ในโฟลเดอร์ repo ของคุณ หากเจอข้อผิดพลาด อาจเป็นเพราะคุณยังไม่ได้ติดตั้ง Node.js

ขั้นตอนสุดท้ายคือรันเว็บไซต์เอกสารในเครื่อง ใช้คำสั่งนี้เพื่อ build เว็บไซต์ docs:

npm start

เมื่อเสร็จแล้ว เว็บไซต์เวอร์ชันในเครื่องจะเปิดขึ้นในเบราว์เซอร์เริ่มต้นของคุณที่พอร์ต 3000 เวอร์ชันนี้เหมือนกับโปรดักชัน คุณสามารถทดสอบทุกอย่างได้ตามต้องการ!

เมื่อพอใจกับการเปลี่ยนแปลงแล้ว คุณสามารถไปยังส่วนถัดไปเพื่อสร้าง Pull Request ส่งเนื้อหาไปยัง repository เอกสารหลักได้เลย

ขั้นตอนที่ 3: ส่งเนื้อหา

เมื่อคุณทำการแก้ไขที่จำเป็นซึ่งเชื่อว่าปฏิบัติตามแนวทางของเราอย่างเคร่งครัดและมีคุณภาพสูงแล้ว คุณสามารถสร้าง Pull Request ได้ โดยไปที่ fork ของคุณใน ZAP Docs repository กดข้อความ Contribute ที่อยู่ใต้ปุ่มหลัก แล้วเปิด pull request

หน้าต่างใหม่จะเปิดขึ้นเพื่อให้คุณดูการเปลี่ยนแปลงที่คุณทำ โดยค่าเริ่มต้น คำอธิบายจะมีเช็คลิสต์เล็ก ๆ เพื่อให้แน่ใจว่าคุณทำทุกอย่างถูกต้องและครบถ้วน คุณสามารถลบเทมเพลตนี้ได้หลังจากตรวจสอบแล้วเพราะไม่จำเป็นต้องใช้

ถัดไป ตั้งชื่อเรื่องที่เหมาะสมเพื่ออธิบายสิ่งที่ทำ ในคำอธิบาย โปรดระบุหรือเชื่อมโยงข้อเสนอของคุณโดยใช้ #000 พร้อมหมายเลข ID ของข้อเสนอนั้น หากหาไม่เจอในเมนู คุณสามารถไปที่ ZAP Docs GitHub repository ส่วน issues แล้วค้นหาข้อเสนอของคุณพร้อมหมายเลข ID

เมื่อกรอกชื่อเรื่อง คำอธิบาย และตรวจสอบความถูกต้องของการเปลี่ยนแปลงแล้ว คุณสามารถสร้าง pull request เพื่อส่งไปยัง repository ของเราได้เลย

ระบบของเราจะตรวจสอบให้แน่ใจว่าการเปลี่ยนแปลงของคุณผ่านการตรวจสอบไวยากรณ์และคุณภาพ หากผ่านทั้งสองอย่าง Pull Request ของคุณจะถูกรีวิวโดยทีม ZAP-Docs ภายในไม่กี่วัน

เมื่อรีวิว Pull Request เราอาจขอให้คุณแก้ไขเพิ่มเติมตามที่เห็นสมควร หรือเราอาจแก้ไขเองในส่วนที่เหมาะสม เมื่อแก้ไขเสร็จสิ้น เราจะอนุมัติการเปลี่ยนแปลงเพื่อเตรียมเผยแพร่

ขั้นตอนที่ 4: เผยแพร่คู่มือและจ่ายรางวัล

เมื่อเราอนุมัติ Pull Request ของคุณหลังจากแก้ไขตามคำขอแล้ว เราจะตอบกลับใน Pull Request แจ้งข้อมูลสำคัญเกี่ยวกับการเผยแพร่คู่มือของคุณ รวมถึงการจ่ายรางวัลสำหรับการทำคู่มือสำเร็จ

ข้อมูล

รางวัลสำหรับการมีส่วนร่วมประเภทนี้ขึ้นอยู่กับหลายปัจจัย โดยเฉพาะคุณภาพและขนาดของเนื้อหาที่เขียน รวมถึงเกณฑ์อื่น ๆ ที่ทีม ZAP Contribution ประเมิน อ่านเพิ่มเติมเกี่ยวกับเกณฑ์ของเราได้ใน Rewards

ขอแสดงความยินดีที่ร่วมสร้างคู่มือของ ZAP-Hosting กับเรา! เราขอบคุณสำหรับทุกการมีส่วนร่วมของคุณ! 💚