พื้นที่เก็บข้อมูลนี้เป็นแหล่งข้อมูลหลักของเอกสารสำหรับนักพัฒนาสำหรับ Flatpak สามารถอ่านได้ที่ docs.flatpak.org
เอกสารบางอย่างยังมีอยู่ในวิกิ Flatpak และเป็นส่วนหนึ่งของหน้าคู่มือผู้สร้าง flatpak และ flatpak-builder
เอกสารถูกเขียนใน reStructuredText และยินดีต้อนรับการมีส่วนร่วม!
สร้างสภาพแวดล้อมเสมือน Python:
python3 -m venv .venv && แหล่งที่มา .venv/bin/activate
จากนั้นติดตั้งการพึ่งพาด้วย pip :
pip ติดตั้ง -r ข้อกำหนด.txt
หลังจากตั้งค่า คุณสามารถสร้างเอกสารประกอบได้:
ทำ -C docs html
ทำการทดสอบ:
ทำ -C docs linkcheck
คุณสามารถเรียกใช้เซิร์ฟเวอร์ HTTP และไปตามลิงก์ที่พิมพ์ออกมา (localhost:8000) เพื่อดูเอกสารประกอบในเบราว์เซอร์ของคุณ:
python3 -m http.server -d docs/_build/html
ตามค่าเริ่มต้น เอกสารที่กำลังสร้างจะเป็นภาษาอังกฤษ หากคุณต้องการสร้างเอกสารในภาษาอื่น เช่น จีน คุณสามารถใช้คำสั่งต่อไปนี้:
ทำ -C เอกสาร html SPHINXOPTS='-D language=zh_CN'
คุณสามารถเปิดคำขอดึงโดยเพิ่มภาษาใหม่ได้
ผู้ดูแลสามารถสร้างไฟล์เทมเพลต ( .pot ) อัปเดตไฟล์การแปล ( .po ) และลบไฟล์การแปลที่ล้าสมัย (เช่น ไฟล์ .pot ที่ตรงกันไม่มีอยู่อีกต่อไป) โดยเรียกใช้:
make -C docs update-po
นักพัฒนาแอปพลิเคชันเดสก์ท็อปเป็นกลุ่มผู้ชมหลักของเอกสาร Flatpak โดยเฉพาะผู้เขียนแอปพลิเคชันที่มีอยู่ รวมถึงแอปพลิเคชันจากแพลตฟอร์มที่ไม่ใช่ Linux
เอกสารควรสะท้อนถึงแนวปฏิบัติยอดนิยมในหมู่ผู้ชมกลุ่มนี้เมื่อเป็นไปได้ และไม่ถือว่าแอปพลิเคชันมาจากพื้นที่เดสก์ท็อป Linux ในทางปฏิบัติ นี่หมายความว่าเราควรคาดหวัง:
Git สำหรับการควบคุมเวอร์ชัน
GitHub สำหรับการโฮสต์
รันไทม์ของเดสก์ท็อปฟรี
ไม่มีความรู้มาก่อนเกี่ยวกับแบบแผนเดสก์ท็อป Linux เช่น ไฟล์ .desktop , AppStream และ D-Bus
นอกเหนือจากค่าเริ่มต้นพื้นฐานเหล่านี้ ควรให้ความสนใจเป็นพิเศษกับเทคโนโลยีข้ามแพลตฟอร์มยอดนิยม เช่น Electron และ Qt
คำแนะนำสำหรับผู้ที่ต้องการร่วมสมทบทุนในเอกสาร:
อธิบายแนวคิดพื้นฐานของ Flatpak
มุ่งเน้นไปที่ขั้นตอนการทำงานของนักพัฒนาแอปพลิเคชันมาตรฐาน
ใช้เอกสารเพื่ออธิบายคุณประโยชน์ของ Flatpak และสาเหตุที่นักพัฒนาอาจนำไปใช้
ครอบคลุมเฉพาะสิ่งที่จำเป็นสำหรับนักพัฒนาแอปพลิเคชัน - อย่าใส่รายละเอียดภายในของ Flatpak เว้นแต่จะจำเป็นจริงๆ
มอบประสบการณ์นักพัฒนาซอฟต์แวร์ที่ราบรื่นและราบรื่นที่สุดเท่าที่จะเป็นไปได้
ช่วยป้องกันปัญหาโดยการคาดการณ์ปัญหาที่อาจเกิดขึ้นที่ผู้พัฒนาอาจเจอ และหลีกเลี่ยงปัญหาเหล่านั้น
