ขั้นตอนการเผยแพร่เอกสาร (Deployment Flow)
เพื่อให้มั่นใจว่าเอกสารของ THAP Engine ทันสมัยและเข้าถึงได้ทั่วโลกเสมอ เราใช้ GitHub Actions ในการจัดการกระบวนการเผยแพร่แบบอัตโนมัติ
🔄 กระบวนการอัตโนมัติ (CI/CD)
ขั้นตอนการทำงาน (Flow) มีดังนี้:
- Push to Master: ทุกครั้งที่มีการส่งโค้ดหรือเอกสารเข้าสู่กิ่ง (Branch)
masterหรือmain - GitHub Action Trigger: สคริปต์ใน
.github/workflows/gh-pages.ymlจะเริ่มทำงาน - Environment Setup: ระบบจำลองจะติดตั้ง Python และธีม
mkdocs-material - Build & Deploy: MkDocs จะสร้างไฟล์เว็บไซต์และส่งไปยังกิ่ง
gh-pages - Live Site: เอกสารจะถูกอัปเดตบนเว็บไซต์
https://<your-username>.github.io/micro-ai-robot-thap-firmware/โดยอัตโนมัติ
🛠️ การตั้งค่าครั้งแรก
หากเป็นการเริ่มใช้ Repository ใหม่ คุณต้องเปิดใช้งาน GitHub Pages ดังนี้:
- ไปที่หน้า Settings ของ Repository บน GitHub
- เลือกเมนู Pages ด้านซ้ายมือ
- ในส่วน Build and deployment > Source ให้เลือก Deploy from a branch
- ในส่วน Branch ให้เลือกกิ่ง
gh-pagesและโฟลเดอร์/ (root) - กด Save
[!NOTE] เอกสารรองรับ 2 ภาษา ผู้ใช้งานสามารถเลือกภาษาได้จากเมนูนำทางหรือหน้าแรกของเว็บไซต์