ປະກອບສ່ວນເຂົ້າໃນເອກະສານ Quick Docs

ທີມງານເອກະສານ Fedora. Version all versions Last review: 2023-08-25
ເປົ້າໝາຍແມ່ນການປ່ຽນຈາກ wiki ທີ່ປົນເປດ້ວຍຄູ່ມື, ຮ່າງເອກະສານ, ແລະ ບັນທຶກພາຍໃນ ມາເປັນຄູ່ມືການໃຊ້ງານທີ່ເປັນລະບົບ ແລະ ບົດຮຽນທີ່ມີລະຫັດຕົວຢ່າງ ໂດຍຜ່ານລະບົບການເຮັດວຽກແບບ pull-request. ພວກເຮົາຂໍຂອບໃຈໃນການຊ່ວຍເຫຼືອຂອງທ່ານ!

ຂັ້ນຕອນ

  1. ເລືອກເອກະສານທີ່ຕ້ອງການອັບເດດ. ທ່ານສາມາດຊອກຫາເອກະສານທີ່ຕ້ອງການການປັບປຸງໄດ້ໃນໄຟລ໌ modules/ROOT/nav.adoc. ເຊິ່ງພວກມັນຈະຢູ່ໃນແຖວທີ່ຖືກຄອມເມັ້ນໄວ້ (ແຖວທີ່ຂຶ້ນຕົ້ນດ້ວຍ //FIXME).

  2. Fork ຄັງເກັບ (repo) https://forge.fedoraproject.org/docs/quick-docs.

  3. ທຳການປ່ຽນແປງໃນໄຟລ໌ .adoc ທີ່ທ່ານຕ້ອງການປັບປຸງ.

  4. ຍົກເລີກການຄອມເມັ້ນໄຟລ໌ໃນ nav.adoc ແລະ ລຶບ FIXME ອອກຈາກ xref..

  5. ສ້າງການເບິ່ງຕົວຢ່າງພາຍໃນເຄື່ອງ ເພື່ອໃຫ້ແນ່ໃຈວ່າການປ່ຽນແປງຂອງທ່ານອອກມາຕາມທີ່ຕ້ອງການ: ກວດສອບໃຫ້ແນ່ໃຈວ່າທ່ານໄດ້ຕິດຕັ້ງ Podman ຫຼື Docker ແລ້ວ, ສຳລັບ Linux desktop ໃຫ້ລັນ ./docsbuilder.sh. ສຳລັບ macOS ໃຫ້ລັນ ./docsbuilder.sh -p ຫຼື ./preview.sh. ປະຕິບັດຕາມຄຳແນະນຳທີ່ສະແດງເທິງ command line.

  6. ເມື່ອທ່ານພໍໃຈກັບການອັບເດດແລ້ວ, ໃຫ້ສົ່ງ pull request ພ້ອມກັບການປັບປຸງຂອງທ່ານ.

  7. ຫາກມີການຍ້າຍໜ້າຈາກ wiki, ໃຫ້ສ້າງການປ່ຽນເສັ້ນທາງ (redirect) ໃນໜ້າເກົ່າ — ເບິ່ງລາຍລະອຽດດ້ານລຸ່ມ.

ແຫຼ່ງຂໍ້ມູນທີ່ອາດເປັນໄປໄດ້

ບາງທີທ່ານອາດພຽງແຕ່ຕ້ອງການປັບປຸງເອກະສານທີ່ມີຢູ່ແລ້ວ, ເຊິ່ງຂັ້ນຕອນຂ້າງເທິງນັ້ນກໍພຽງພໍແລ້ວ. ຫຼື ບາງທີທ່ານອາດມີບາງຢ່າງໃນໃຈແລ້ວ. ແຕ່ຖ້າທ່ານສົນໃຈຢາກຊ່ວຍແຕ່ບໍ່ຮູ້ຈະເລີ່ມບ່ອນໃດ, ນີ້ແມ່ນບາງບ່ອນທີ່ທ່ານສາມາດຊອກຫາໄອເດຍໄດ້:

  • ໝວດໝູ່ How To ແບບເກົ່າໃນ Fedora wiki. ເອກະສານຈຳນວນຫຼາຍໃນນັ້ນແມ່ນພ້ອມທີ່ຈະຖືກປ່ຽນຮູບແບບ. (ຫຼາຍອັນກໍເກົ່າຫຼາຍແລ້ວ!)

  • ຄຳຖາມກ່ຽວກັບ ບັນຫາທົ່ວໄປ (Common Issues) ໃນ Ask Fedora.

  • ຄຳຖາມກ່ຽວກັບ Fedora ທີ່ພົບເລື້ອຍໆໃນ Stack Exchange.

  • ບົດຄວາມຈາກ Fedora Magazine. ຮູບແບບຂອງວາລະສານຈະເປັນການສົນທະນາ ແລະ ເຂົ້າໃຈໄດ້ວ່າເປັນຂໍ້ມູນໃນຊ່ວງເວລາໃດໜຶ່ງ. ສຳລັບເວີຊັນ Quick Docs ຄວນຈະກະທັດຮັດກວ່າ ແລະ ຕ້ອງໄດ້ຮັບການອັບເດດຢູ່ສະເໝີຫາກມີການປ່ຽນແປງຄຳສັ່ງ ຫຼື ວິທີການທີ່ດີທີ່ສຸດ.

ການປ່ຽນເສັ້ນທາງ Wiki

ໂດຍທົ່ວໄປແລ້ວ, wiki ຈະບໍ່ອະນຸຍາດໃຫ້ປ່ຽນເສັ້ນທາງໄປຍັງເວັບໄຊພາຍນອກ ເນື່ອງຈາກມີຄວາມສ່ຽງໃນການຖືກນຳໃຊ້ໄປໃນທາງທີ່ຜິດສູງ. ພວກເຮົາໄດ້ພັດທະນາ plugin ສຳລັບ Fedora Wiki ເຊິ່ງອະນຸຍາດໃຫ້ປ່ຽນເສັ້ນທາງໄປຍັງ ສະເພາະ ໜ້າຕ່າງໆໃນເວັບໄຊນີ້ເທົ່ານັ້ນ https://docs.fedoraproject.org/. ເພື່ອສ້າງລິ້ງດັ່ງກ່າວ, ໃຫ້ໃຊ້ macro #fedoradocs ໂດຍການວາງຂໍ້ຄວາມປະມານນີ້ໄວ້ທາງເທິງຂອງໜ້າ wiki ທີ່ທ່ານກຳລັງຈະປ່ຽນແທນ:

{{#fedoradocs: https://docs.fedoraproject.org/en-US/council/fpl/}}

ແນ່ນອນວ່າ, ທ່ານຄວນປ່ຽນ URL ຕົວຢ່າງນັ້ນດ້ວຍ URL ຂອງໜ້າເປົ້າໝາຍໃໝ່ຂອງທ່ານ. ຢ້ຳອີກຄັ້ງ, URL ບໍ່ສາມາດເປັນອັນໃດກໍໄດ້ຕາມໃຈ, ແຕ່ມັນ ຈະຕ້ອງ ຂຶ້ນຕົ້ນດ້ວຍ https://docs.fedoraproject.org/.

ເມື່ອການປ່ຽນເສັ້ນທາງຖືກຕັ້ງຄ່າແລ້ວ, ຜູ້ເຂົ້າຊົມໜ້າ wiki ນັ້ນຈະຖືກສົ່ງໄປ (ປ່ຽນເສັ້ນທາງດ້ວຍລະຫັດ 301 Moved Permanently) ມາຍັງເວັບໄຊເອກະສານທັນທີ.

ໝາຍເຫດ: ບໍ່ມີການກວດສອບວ່າປາຍທາງນັ້ນມີຢູ່ແທ້ ຫຼື ຖືກຕ້ອງຫຼືບໍ່ — ກະລຸນາກວດສອບຄືນໃຫ້ແນ່ໃຈວ່າການປ່ຽນເສັ້ນທາງທີ່ທ່ານສ້າງນັ້ນເຮັດວຽກໄດ້ຢ່າງຖືກຕ້ອງກ່ອນຈະດຳເນີນຂັ້ນຕອນຕໍ່ໄປ.

ຫາກທ່ານຕ້ອງການແກ້ໄຂໜ້າດັ່ງກ່າວເພື່ອແກ້ໄຂ URL ຫຼື ເພື່ອລຶບການປ່ຽນເສັ້ນທາງອອກດ້ວຍເຫດຜົນໃດໜຶ່ງ, ໃຫ້ສ້າງ URL ຂອງເວັບໄຊ wiki ດ້ວຍ &action=edit ເຊັ່ນ:

https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

Want to help? Learn how to contribute to Fedora Docs ›