ซิงก์หลายโฟลเดอร์ของ GitHub
หากคุณมีหลายโฟลเดอร์ในรีโปของคุณที่ใช้สำหรับเอกสาร ตอนนี้คุณสามารถซิงก์ทั้งหมดเข้ากับ Archbee ได้แล้ว
การเตือนความจำเกี่ยวกับวิธีการเชื่อมต่อ Archbee และ GitHub:
หากคุณต้องการทบทวนวิธีการ ผสานการทำงานระหว่างสองอย่าง, นี่คือคำแนะนำฉบับเต็ม
จนถึงตอนนี้ คุณสามารถใช้ไฟล์ .archbee.yaml ใน โฟลเดอร์เดียว และสำหรับโปรเจกต์เอกสารเดียว ตอนนี้คุณสามารถทำได้กับหลายโฟลเดอร์
หาก Archbee พบไฟล์ .archbee.yaml ในรูทของรีโปหรือโฟลเดอร์ใด ๆ เราจะใช้ไฟล์นั้นเพื่อจัดระเบียบเนื้อหา เป็นไฟล์เดียวกันในทุกโฟลเดอร์ที่คุณเก็บเอกสารไว้ นี่คือตัวอย่างการตั้งค่าและกำหนดค่า Git รีโปของคุณเพื่อให้ Archbee สามารถดึงเนื้อหาและจัดเรียงให้เข้ากับซอฟต์แวร์ของเราได้อย่างเหมาะสม > รีโป Archbee
ตั้งค่ารีโป
โปรดดูรีโป Archbee ที่กล่าวถึงข้างต้น
หากระบบพบไฟล์ .archbee.yaml ในรูทของรีโป เช่น ตัวอย่างนี้ จากนั้นระบบจะใช้ไฟล์นั้นในการจัดระเบียบเนื้อหา หากไม่พบ เราจะตั้งค่าเริ่มต้นให้โดยอัตโนมัติ
สร้างไฟล์ .yaml สำหรับหลายๆ โฟลเดอร์
สร้างไฟล์ .archbee.yaml โดยใช้โครงสร้างตัวแปรดังต่อไปนี้
คุณต้องวางไฟล์ไว้ในโฟลเดอร์รูทของคลังเก็บ (repository) ของคุณ ตรวจสอบให้แน่ใจว่าไฟล์ยังคงอยู่ที่ตำแหน่งนั้น เนื่องจากเป็นเส้นทางเริ่มต้นสำหรับโฟลเดอร์อื่นทั้งหมด
- root: ./docs เป็นพร็อพเพอร์ตี้ที่กำหนดตำแหน่งไดเรกทอรีที่มีเอกสาร (สามารถแทนที่ด้วย docsPath: ./docs)
- structure:
- summary: summary.md ใช้สร้างโครงสร้างเอกสารในแถบเมนูด้านซ้ายใน Archbee หากไม่มีไฟล์นี้ จะใช้โฟลเดอร์เป็นหมวดหมู่และล้อโครงสร้างไฟล์ภายใน
- assets: assets โฟลเดอร์ assets เป็นพาธที่สัมพันธ์กับ docsPath โดย Archbee จะอัปโหลดไฟล์ทั้งหมดที่อยู่ในโฟลเดอร์นี้
- # ส่วนนี้จะรวมไฟล์โค้ดทั้งหมดจาก repository ของคุณ
- shadowDocs ใช้กำหนดไฟล์/โฟลเดอร์โค้ดที่จะถูกรวมเป็น Shadow Docs
- publishSpace เป็นค่า boolean ให้ตั้งเป็น true เพื่อเผยแพร่ space ไปยัง production portal หลังจากแต่ละ commit
ด้านล่างนี้เป็นตัวอย่างของไฟล์คอนฟิก archbee.yaml พร้อมด้วยค่า default สำหรับพาธ (โฟลเดอร์)
root: ./docs
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> ตัวอย่างของ archbee.yaml ไฟล์คอนฟิกที่มี subpaths:
root: folderx
structure:
summary: summary.md
assets: assets
publishSpace: true
headerIncludes: |
<script>
document.getElementById("demo").innerHTML = "Hello JavaScript!";
</script> เมื่อคุณทำเสร็จแล้ว ให้กลับไปที่ Archbee และตรวจสอบว่าคุณสามารถเลือกโฟลเดอร์หลายโฟลเดอร์ในเมนูดรอปดาวน์ได้หรือไม่:
เรายังแนะนำให้คุณสร้างไฟล์ summary.md ไฟล์นี้ใช้สร้างโครงสร้างเอกสารในแถบการนำทางด้านซ้ายใน Archbee และช่วยให้คุณจัดระเบียบเนื้อหาได้อย่างเป็นระเบียบ
ดูตัวอย่างของไฟล์ summary.md ด้านล่าง:
- [Introduction](1.md)
## Table of contents
- [Init](init.md)
- [Configure App](config.md)
- [Config Database](config-database.md)
- [Config Redis](config-redis.md)
- [Config Elastic Search](config-es.md)
- [Swagger](swagger-v2.json)
ซิงก์ใน Archbee
เมื่อคุณสร้างพื้นที่ใหม่ เลือกรีโปของคุณ การเปลี่ยนแปลงจะถูกซิงก์ใน Archbee โดยอัตโนมัติ
หากสิ่งนั้นไม่ทำงานโดยอัตโนมัติ คุณสามารถบังคับให้ซิงก์ได้โดยไปที่ การตั้งค่าพื้นที่ > การเชื่อมต่อ GitHub > คลิกปุ่ม ซิงก์กับรีโป
