ສ້າງໂມດູນເອກະສານໃໝ່
ສ່ວນນີ້ອະທິບາຍກ່ຽວກັບວິທີການເພີ່ມເອກະສານໃໝ່ທັງໝົດ ເຊິ່ງກວມເອົາເນື້ອຫາໃໝ່ຢ່າງຄົບຖ້ວນ. ສ່ວນນີ້ຈະມີຫຼາຍໜ້າ ແລະ ປົກກະຕິແລ້ວຈະກ່ຽວຂ້ອງກັບການສ້າງບ່ອນເກັບຂໍ້ມູນ (repository) ໃໝ່ສະເພາະ. ການນຳໃຊ້ສະພາບແວດລ້ອມການເຮັດວຽກແບບພາຍໃນ (local) ແມ່ນເໝາະສົມທີ່ສຸດສຳລັບວຽກນີ້. ແຕ່ກໍສາມາດນຳໃຊ້ web IDE ຂອງບໍລິການ GIT ຕ່າງໆໄດ້ເຊັ່ນກັນ.
ກ່ອນທີ່ທ່ານຈະເລີ່ມປະຕິບັດຕາມຂັ້ນຕອນນີ້, ກະລຸນາກວດສອບຂໍ້ກຳນົດທັງໝົດທີ່ລະບຸໄວ້ໃນ Prerequisites.
ການກຳນົດຄ່າບ່ອນເກັບຂໍ້ມູນເອກະສານ
| ເຖິງວ່າທ່ານຈະສາມາດສ້າງບ່ອນເກັບຂໍ້ມູນໃໝ່ ຫຼື ໃຊ້ບ່ອນເກັບຂໍ້ມູນທີ່ມີຢູ່ແລ້ວກໍຕາມ, ແຕ່ພວກເຮົາແນະນຳໃຫ້ເລີ່ມຈາກບ່ອນເກັບຂໍ້ມູນແມ່ແບບ (template repository) ທີ່ຈັດກຽມໄວ້ໃຫ້ ຫາກທ່ານຍັງບໍ່ຄຸ້ນເຄີຍກັບ Antora. |
Create your new repository for the new documentation set, or ask someone to create one for you. You can host this repository anywhere but we recommend using Fedora Forge where you can use Fedora groups to control write access to the repository.
Simply clone the template repository manually and copy the content to your new repository.
📄 antora.yml
📄 site.yml
📂 modules
📂 ROOT
📄 nav.adoc
📂 pages
📄 index.adoc
📄 another-page.adoc
ໃນບ່ອນເກັບຂໍ້ມູນໃໝ່, ໃຫ້ແກ້ໄຂໄຟລ໌ກຳນົດຄ່າ antora.yml ຢູ່ໃນໂຟນເດີຫຼັກ (root). ໄຟລ໌ນີ້ຈະມີຄຳອະທິບາຍ (comments) ທີ່ບອກວ່າສ່ວນໃດແດ່ທີ່ທ່ານຕ້ອງປ່ຽນ. ຢ່າງໜ້ອຍທີ່ສຸດ, ໃຫ້ປ່ຽນ name ແລະ title ສະເໝີ.
name ແມ່ນສິ່ງທີ່ຈະກຳນົດ URL ສຸດທ້າຍຂອງເອກະສານຂອງທ່ານ. ຕົວຢ່າງ: docs.fedoraproject.org/en-US/<name>/
|
ນອກຈາກນັ້ນ, ໃຫ້ແກ້ໄຂໄຟລ໌ກຳນົດຄ່າ site.yml. ໝາຍເຫດ: ໄຟລ໌ນີ້ຈະຖືກນຳໃຊ້ສະເພາະຕອນສ້າງການສະແດງຕົວຢ່າງ (preview) ແບບພາຍໃນເທົ່ານັ້ນ - ເມື່ອຢູ່ເທິງເວັບໄຊ ມັນຈະຖືກແທນທີ່ດ້ວຍການກຳນົດຄ່າ site.yml ຂອງເວັບໄຊທັງໝົດ. ຄຳສັ່ງດຽວທີ່ທ່ານຕ້ອງແກ້ໄຂໃນໄຟລ໌ນີ້ຄື title ແລະ start_page.
ມາຮອດຂັ້ນຕອນນີ້, ການກຳນົດຄ່າເບື້ອງຕົ້ນແມ່ນສຳເລັດແລ້ວ. ທ່ານສາມາດສົ່ງ (push) ການປ່ຽນແປງເຫຼົ່ານີ້ໄປຍັງບ່ອນເກັບຂໍ້ມູນທີ່ສ້າງຂຶ້ນໃໝ່ (ຫຼື ສ້າງ pull request ຫາກທ່ານບໍ່ມີສິດທີ່ຈຳເປັນ) ແລະ ເລີ່ມຂຽນເອກະສານຕົວຈິງໄດ້ເລີຍ.
ການຂຽນເອກະສານ
ລິງກ໌ເອກະສານທີ່ມີປະໂຫຍດບາງຢ່າງ:
ຫາກເອກະສານຂອງທ່ານປະກອບມີຫຼາຍໜ້າ, ທ່ານສາມາດລະບຸລາຍຊື່ໜ້າເຫຼົ່ານັ້ນໄວ້ໃນ nav.adoc. ໄຟລ໌ນີ້ຈະຖືກນຳໃຊ້ເພື່ອສ້າງເມນູນຳທາງ (navigation menu) ຢູ່ເບື້ອງຊ້າຍຂອງ docs.fp-o.
ໃນຂະນະທີ່ທ່ານກຳລັງຂຽນ, ທ່ານສາມາດໃຊ້ ການສະແດງຕົວຢ່າງພາຍໃນ ເພື່ອກວດສອບເອກະສານທີ່ໄດ້.
ເຜີຍແຜ່ໂມດູນເອກະສານໃໝ່
ເມື່ອຕັ້ງຄ່າບ່ອນເກັບຂໍ້ມູນ ແລະ ເພີ່ມເນື້ອຫາເບື້ອງຕົ້ນແລ້ວ, ມັນກໍພ້ອມທີ່ຈະຖືກເຜີຍແຜ່.
Documentation modules published on docs.fp-o are all listed in the main Antora playbook.
ເພື່ອເພີ່ມໂມດູນເອກະສານໃໝ່, ທ່ານຈຳເປັນຕ້ອງເພີ່ມບ່ອນເກັບຂໍ້ມູນຂອງມັນເຂົ້າໃນລາຍການ content.sources:
content:
sources:
- url: https://forge.fedoraproject.org/path/to/new/repository.git
branches: main (1)
start_path: docs (2)
| 1 | ສາຂາ (branch) ເລີ່ມຕົ້ນແມ່ນຖືກຕັ້ງໄວ້ເປັນ master. ຫາກບ່ອນເກັບຂໍ້ມູນຂອງທ່ານໃຊ້ຊື່ອື່ນ (ເຊັ່ນ main), ທ່ານຕ້ອງລະບຸມັນຢູ່ທີ່ນີ້. <.> ການຕັ້ງຄ່ານີ້ແມ່ນທາງເລືອກ. ຫາກໄຟລ໌ເອກະສານຖືກເກັບໄວ້ໃນໂຟນເດີຍ່ອຍໃນບ່ອນເກັບຂໍ້ມູນຂອງທ່ານ (ຕົວຢ່າງ /docs/), ທ່ານຕ້ອງກຳນົດເສັ້ນທາງ (path) ຂອງມັນຢູ່ທີ່ນີ້ ໂດຍບໍ່ຕ້ອງມີເຄື່ອງໝາຍ slash (/) ທາງໜ້າ ຫຼື ທາງຫຼັງ. ຫາກມັນຕັ້ງຢູ່ໃນລະດັບຫຼັກ (root level) ຄືກັບທີ່ອະທິບາຍໃນໜ້ານີ້, ທ່ານສາມາດຂ້າມຂັ້ນຕອນນີ້ໄດ້. |
You can either create a Pull Request with these changes, or if you do not feel comfortable editing this file, create a ticket on the Fedora Docs Website repository, and the Documentation Team will handle that part for you.
|
ຫາກທ່ານບໍ່ໄດ້ຮັບການອັບເດດກ່ຽວກັບ Merge Request ຫຼື ticket ຂອງທ່ານຫຼັງຈາກ 5 ວັນ, ໃຫ້ຕິດຕໍ່ທີມງານເອກະສານ. |
Want to help? Learn how to contribute to Fedora Docs ›