ວິທີການສ້າງ ແລະ ນຳໃຊ້ຂະບວນການເຮັດວຽກເອກະສານ Fedora ຢູ່ໃນເຄື່ອງ

ທີມງານເອກະສານ Fedora <https://discussion.fedoraproject.org/tag/docs-team> Last review: 2024-08-30

Many of the repositories have now been migrated to Fedora Forge. See the updated Edit from a local clone guide.
ໃນສະພາບແວດລ້ອມແບບທ້ອງຖິ່ນ (Local), ທ່ານສາມາດສ້າງ ຫຼື ແກ້ໄຂເອກະສານຂອງທ່ານແບບອອຟໄລໄດ້. ທ່ານນຳໃຊ້ຄັງເກັບຂໍ້ມູນ git ຢູ່ໃນເຄື່ອງ ເຊິ່ງປະກອບມີຊຸດເອກະສານ ແລະ ເຄື່ອງມືສຳລັບແກ້ໄຂຢ່າງຄົບຖ້ວນ. ຫຼັງຈາກການແກ້ໄຂສຳເລັດແລ້ວ, ສາມາດເບິ່ງຕົວຢ່າງຜ່ານການ build ໜ້າ Docs ຢູ່ໃນເຄື່ອງ. ນີ້ແມ່ນວິທີການທີ່ຍືດຫຍຸ່ນທີ່ສຸດໃນການເຮັດວຽກກັບຄັງເກັບຂໍ້ມູນ Docs, ເຊິ່ງຮອງຮັບການປັບແຕ່ງໃຫ້ເຂົ້າກັບຂັ້ນຕອນການເຮັດວຽກ ແລະ ອຸປະກອນຂອງແຕ່ລະບຸກຄົນ. ສະພາບແວດລ້ອມການຂຽນຢູ່ໃນເຄື່ອງຊ່ວຍໃຫ້ເຂົ້າເຖິງຊັບພະຍາກອນທັງໝົດທີ່ທ່ານໃຊ້ເປັນປະຈຳຢູ່ໃນເຄື່ອງຂອງທ່ານໄດ້ຢ່າງເຕັມທີ່ ແລະ ສາມາດປັບໃຫ້ເຂົ້າກັບຮູບແບບການເຮັດວຽກຂອງທ່ານໄດ້ຢ່າງສົມບູນ. ມັນເໝາະສົມເປັນພິເສດສຳລັບການສ້າງຊຸດເອກະສານໃໝ່ທັງໝົດໃນຫົວຂໍ້ໃດໜຶ່ງ ຫຼື ສຳລັບການປັບປຸງຊຸດເອກະສານທີ່ມີຢູ່ແລ້ວ. ບົດຄວາມນີ້ຍົກຕົວຢ່າງຂອງຄັງເກັບຂໍ້ມູນໂຄງການ Fedora ໃນ GitLab, ແຕ່ຂະບວນການໂດຍລວມສາມາດນຳໄປໃຊ້ກັບໂຄງການໃນ Pagure ແລະ GitHub ໄດ້.

ເງື່ອນໄຂເບື້ອງຕົ້ນ

  1. ທ່ານຕ້ອງມີຄຸນສົມບັດຕາມຂໍ້ກຳນົດພື້ນຖານທີ່ລະບຸໄວ້ໃນ ຂຽນການປະກອບສ່ວນເຂົ້າໃນ Docs.

  2. ຂະບວນການເຮັດວຽກນີ້ໃຊ້ເຄື່ອງມື command line ໃນເກືອບທຸກຂັ້ນຕອນ. ດັ່ງນັ້ນ, ຈຶ່ງຈຳເປັນຕ້ອງມີປະສົບການໃນການນຳໃຊ້ Linux Terminal ຫຼື ຕ້ອງຮຽນຮູ້ໄປພ້ອມໆກັນ.

ການຕັ້ງຄ່າສະພາບແວດລ້ອມການຂຽນ

ການກຽມຕົວ

  1. ໃຊ້ SSH keys ເພື່ອຢືນຢັນຕົວຕົນກັບເຊີເວີ GitLab.

  2. ໃຊ້ຄີ GPG (GNU Privacy Guard) ເພື່ອເຊັນຢືນຢັນການ commits ວ່າໄດ້ຮັບການກວດສອບແລ້ວ.

ໃນ GitLab, ໃຫ້ໄປທີ່ Preferences - User Settings - Add an SSH Key / a GPG Key

Git ແລະ Podman ມີມານຳ Fedora workstation ເປັນມາດຕະຖານຢູ່ແລ້ວ. ສ່ວນ Podman container ຈະຖືກຕັ້ງຄ່າໂດຍອັດຕະໂນມັດ.

ສ້າງໂຟນເດີຍ່ອຍ (subdirectory) ຢູ່ໃນເຄື່ອງເພື່ອເກັບໄຟລ໌ທີ່ clone ມາຈາກຄັງເກັບຂໍ້ມູນ Docs

ສ້າງໄດເຣັກທໍຣີຫຼັກດ້ວຍຄຳສັ່ງ mkdir DirectoryName

$ mkdir ~/FedoraDocs

ຕັ້ງຄ່າຄັງເກັບຂໍ້ມູນ

Fork ໂຄງການ

ໃນ GitLab, ໃຫ້ໄປທີ່ຄັງເກັບຂໍ້ມູນຕົ້ນທາງ (upstream) ແລ້ວກົດປຸ່ມ Fork ຢູ່ດ້ານເທິງ. ເລືອກ namespace (GitLab ID ຂອງທ່ານ) ແລະ ລະດັບການເຂົ້າເຖິງ (visibility level) ສຳລັບໂຄງການທີ່ fork ມາ, ເຊິ່ງຈະເປັນການສ້າງ fork ໄປຫາບັນຊີ GitLab ຂອງທ່ານ.

ຖ້າທ່ານບໍ່ມີສິດໃນການສ້າງໂຄງການ, ໃຫ້ເປີດ issue ticket ໃນ GitLab ເພື່ອໃຫ້ທີມງານສ້າງໃຫ້.

Clone ຄັງເກັບຂໍ້ມູນ

ໃນ repo ທີ່ທ່ານ fork ມາ, ໃຫ້ກົດປຸ່ມ Clone ສີຟ້າ ແລ້ວເລືອກ Clone with SSH. ຈາກນັ້ນກັອບປີ້ລິງນັ້ນໄວ້.

ໄປທີ່ໄດເຣັກທໍຣີເອກະສານຫຼັກຂອງທ່ານ, ແລ້ວທຳການ clone repo.

$ cd FedoraDocs

ເມື່ອທຳການ clone ຄັງເກັບຂໍ້ມູນ, ທ່ານສາມາດກຳນົດຊື່ໄດເຣັກທໍຣີໃໝ່ເປັນ argument ເພີ່ມເຕີມໄດ້. ສິ່ງນີ້ຈະສ້າງໂຟນເດີຍ່ອຍ ContributorsGuide ແລະ clone repo ເຂົ້າໄປໃນໂຟນເດີນັ້ນ.

$ git clone <GIT URL> ContributorsGuide
$ cd ContributorsGuide

ກວດສອບ branch ປັດຈຸບັນ, ເຊິ່ງປົກກະຕິຈະເປັນ main ຫຼື master.

$ git status

ສະແດງ branch ທັງໝົດທີ່ຢູ່ໃນ remote.

$ git branch -v -a

ເພື່ອສ້າງ branch ແລະ ສະຫຼັບໄປໃຊ້ branch ນັ້ນ,

$ git checkout -b <new-branch>

ການເຮັດວຽກກັບເນື້ອຫາ

ເປີດໄຟລ໌ດ້ວຍໂປຣແກຣມແກ້ໄຂຂໍ້ຄວາມ (text editor) ທີ່ທ່ານເລືອກ, ແກ້ໄຂ, ແລະ ບັນທຶກ.

ຊິງຄ໌ (Sync) fork ຂອງທ່ານໃຫ້ກົງກັບຄັງເກັບຂໍ້ມູນຕົ້ນທາງ (upstream)

$ git remote -v

ສິ່ງນີ້ຈະສະແດງໃຫ້ເຫັນ fork ໃນບັນຊີຂອງທ່ານໃນຖານະ origin.

ໄປທີ່ repo ຕົ້ນທາງ (upstream), ກົດປຸ່ມ Clone, ແລະ ກັອບປີ້ຂໍ້ມູນ Clone with SSH.

$ git remote add upstream <SSH URL>

ໃຊ້ຄຳສັ່ງລຸ່ມນີ້ເພື່ອສະແດງທັງ origin ແລະ upstream.

$ git remote -v

ເພື່ອເຮັດໃຫ້ fork ຂອງທ່ານອັບເດດໃຫ້ກົງກັບ upstream ຢູ່ສະເໝີ,

$ git checkout main
$ git fetch upstream
$ git pull upstream main

ຄຳສັ່ງນີ້ຈະດຶງຂໍ້ມູນ commits ຫຼ້າສຸດຈາກ upstream ມາຍັງ branch ໃນເຄື່ອງຂອງທ່ານ.

$ git push origin main

ຄຳສັ່ງນີ້ຈະສົ່ງ (push) commits ຈາກເຄື່ອງຂອງທ່ານໄປຍັງ branch ຫຼັກຂອງ remote origin.

ລັນສະຄຣິບເພື່ອເບິ່ງຕົວຢ່າງຢູ່ໃນເຄື່ອງ

ໄປທີ່ໄດເຣັກທໍຣີທີ່ເກັບ repo ທີ່ clone ມາ, ແລ້ວລັນສະຄຣິບສຳລັບ build ໃນ terminal.

$ ./docsbuilder.sh

ເບິ່ງຕົວຢ່າງໃນບຣາວເຊີຂອງທ່ານໂດຍໃຊ້ທີ່ຢູ່ localhost:8080

ບັນທຶກວຽກຂອງທ່ານ

ເພື່ອເບິ່ງສິ່ງທີ່ເກີດຂຶ້ນກັບຄຳສັ່ງ git add ແລະ git commit.

$ git status

ເພື່ອເພີ່ມການປ່ຽນແປງທີ່ຈະທຳການ commit,

$ git add -A

ຫຼືອີກວິທີໜຶ່ງ, ເພື່ອເພີ່ມໄຟລ໌ທັງໝົດໃນໄດເຣັກທໍຣີທີ່ກຳລັງເຮັດວຽກຢູ່,

$ git add .

ກຽມການປ່ຽນແປງສຳລັບການອັບໂຫຼດ, ເຊິ່ງຈະເປີດ text editor ເພື່ອໃຫ້ທ່ານໃສ່ຂໍ້ຄວາມ commit (commit message).

$ git commit -s

ຄຳສັ່ງ git log ຈະສະແດງປະຫວັດຂອງໂຄງການ ແລະ ການປ່ຽນແປງຕ່າງໆ.

$ git log

ສົ່ງ (Push) ການປ່ຽນແປງໄປຍັງ branch ຂອງທ່ານໃນ fork.

$ git push origin <branch-name>

ສ້າງຄຳຮ້ອງຂໍຮວມ (Merge requests)

ໄປທີ່ repository ທີ່ທ່ານ fork ມາໃນ GitLab.

ຢູ່ເມນູດ້ານຊ້າຍ, ໃຫ້ຄລິກ Merge Requests, ແລ້ວເລືອກປຸ່ມ New merge request ສີຟ້າຢູ່ທາງກາງ.

ເມື່ອທ່ານເຮັດວຽກໃນ fork, ໃຫ້ເລືອກ repository ທີ່ທ່ານ fork ມາເປັນ branch ຕົ້ນທາງ (source branch).

ໃນລາຍການ Target branch, ໃຫ້ເລືອກ branch ຈາກຄັງເກັບຂໍ້ມູນຕົ້ນທາງ (upstream repository) ເປັນ branch ປາຍທາງ.

ຄລິກ Compare branches and continue.

ເລືອກ Create merge request.

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