ຂັ້ນຕອນການເຮັດວຽກ

ຄຳແນະນຳເຫຼົ່ານີ້ຖືວ່າເຈົ້າມີບັນຊີ github ຢູ່ແລ້ວ ແລະ ໄດ້ຕິດຕັ້ງ Git ແລ້ວນຳ. ໃຫ້ແນ່ໃຈວ່າ git ຢູ່ໃນ PATH ຂອງເຈົ້າ ໂດຍການລັນຄຳສັ່ງ git ໃນ terminal ຫຼື cmd ແລະ ກວດເບິ່ງວ່າມັນບໍ່ໄດ້ແຈ້ງຂໍ້ຜິດພາດ ເຊັ່ນ “command not found”. ຖ້າເຈົ້າຍັງບໍ່ທັນໄດ້ຕິດຕັ້ງ git, ໃຫ້ປະຕິບັດຕາມຄຳແນະນຳນີ້.

🔗ການຂຽນເອກະສານສຳລັບຟີເຈີທີ່ຍັງບໍ່ທັນມີຂໍ້ມູນ

ພວກເຮົາມີຄວາມສົນໃຈເປັນພິເສດໃນການຂຽນເອກະສານສຳລັບ pull request ທີ່ຖືກປິດແລ້ວ ເຊິ່ງຈຳເປັນຕ້ອງເພີ່ມ ຫຼື ປ່ຽນແປງຂໍ້ມູນໃນຄູ່ມືນີ້. Pull request ທີ່ຕ້ອງການເອກະສານຈະຖືກຕິດປ້າຍ label ໃນ GitHub ວ່າ documentation: pending.

ຂັ້ນຕອນຫຼັກໆໃນການເຮັດມີດັ່ງນີ້:

  1. ເບິ່ງລາຍການຂອງ Pull Requests ທີ່ຕ້ອງການເອກະສານ.

  2. ເລືອກ Pull Request ທີ່ເຈົ້າເຂົ້າໃຈວ່າການປ່ຽນແປງນັ້ນແມ່ນຫຍັງ.

  3. ຂຽນການປ່ຽນແປງຕາມລາຍລະອຽດໃນ workflow ດ້ານລຸ່ມ.

  4. ເມື່ອເຈົ້າສ້າງ Pull Request, ໃຫ້ໃສ່ລິ້ງໄປຫາ pull request ຈາກຂັ້ນຕອນທີ 1 ນຳ.

🔗ຂັ້ນຕອນການເຮັດວຽກຂອງເອກະສານ

🔗ການຕັ້ງຄ່າຄັ້ງທຳອິດ

ຖ້າເຈົ້າຍັງບໍ່ທັນໄດ້ຕັ້ງຄ່າ git ໃນເຄື່ອງ, ໃຫ້ໃຊ້ສອງຄຳສັ່ງນີ້ເພື່ອຕັ້ງຄ່າຕົວຕົນຂອງເຈົ້າກ່ອນທີ່ຈະ commit:

  1. git config --global user.email "you@example.com"

  2. git config --global user.name "Your Name"

ແລະ ຖ້າເຈົ້າຍັງບໍ່ທັນໄດ້ຢືນຢັນຕົວຕົນ git ໃນເຄື່ອງກັບ github, ໃຫ້ປະຕິບັດຕາມຄຳແນະນຳສຳລັບ GitHub CLI ທີ່ນີ້. ສິ່ງນີ້ຈະເຮັດໃຫ້ໝັ້ນໃຈວ່າເຈົ້າໄດ້ຕັ້ງຄ່າ keys ແລະ ຂໍ້ມູນການຢືນຢັນຕົວຕົນຢ່າງຖືກຕ້ອງ.

ຈາກນັ້ນ ເຈົ້າສາມາດ clone ສຳເນົາຂອງ dtdocs ລົງໃນຄອມພິວເຕີຂອງເຈົ້າໄດ້.

  1. ໄປທີ່ https://github.com/darktable-org/dtdocs.

  2. ກົດປຸ່ມ Fork ແລ້ວຕາມດ້ວຍປຸ່ມ Create fork.

  3. ເຈົ້າຈະຖືກສົ່ງໄປຫາໜ້າ fork ຂອງເອກະສານ darktable ທີ່ເປັນຂອງເຈົ້າເອງ. ກົດປຸ່ມ Code ແລ້ວກັອບປີ້ລິ້ງພາຍໃຕ້ HTTPS.

  4. ເປີດ terminal ຫຼື cmd ໃນໂຟນເດີທີ່ເຈົ້າຕ້ອງການໃຫ້ຄັງເກັບເອກະສານ darktable ຢູ່. ເຊັ່ນ ‘C:\Users\YourUser\Documents' ຫຼື ‘/home/youruser/Documents/builds’. ທັງໃນ windows ແລະ macOS/Linux ເຈົ້າສາມາດໃຊ້ຄຳສັ່ງຕໍ່ໄປນີ້ເພື່ອໄປຍັງໂຟນເດີທີ່ຕ້ອງການ: cd C:\Users\YourUser\Documents\ ໂດຍປ່ຽນເປັນຊື່ໂຟນເດີຂອງເຈົ້າເອງ.

  5. Clone ຄັງເກັບ dtdocs ໂດຍການລັນ: git clone https://github.com/<your username>/dtdocs.git ໂດຍປ່ຽນ URL ເປັນລິ້ງທີ່ເຈົ້າກັອບປີ້ມາໃນຂັ້ນຕອນທີ 3.

  6. ຕອນນີ້ເຈົ້າມີສຳເນົາຂອງຄັງເກັບ dtdocs ໃນ PC ແລ້ວ. ຈະມີການຕັ້ງຄ່າອີກເລັກນ້ອຍກ່ອນທີ່ເຈົ້າຈະເລີ່ມແກ້ໄຂໄຟລ໌ໄດ້.

🔗ການຊິງໂຄຣໄນການປ່ຽນແປງ

  1. ໄປທີ່ repositories ຂອງເຈົ້າໃນ github ແລ້ວເລືອກ darktable ທີ່ເຈົ້າ fork ມາ.

  2. ກົດ Sync fork.

  3. ເປີດ terminal ຫຼື cmd ໃນໂຟນເດີຄັງເກັບ darktable ຂອງເຈົ້າ.

  4. ກວດເບິ່ງໃຫ້ແນ່ໃຈວ່າເຈົ້າບໍ່ມີການປ່ຽນແປງທີ່ຄ້າງຢູ່ໂດຍການລັນ git status ແລ້ວລັນ git checkout master (ຖ້າເຈົ້າເຮັດຕາມຄູ່ມືນີ້ເປັນຄັ້ງທຳອິດ ເຈົ້າຈະຢູ່ທີ່ master ຢູ່ແລ້ວ).

  5. ລັນ git pull (ສິ່ງນີ້ຈະເຮັດໃຫ້ສຳເນົາໃນເຄື່ອງຂອງເຈົ້າອັບເດດໃຫ້ກົງກັບ fork ໃນ github).

ຫຼື ເຈົ້າສາມາດຊິງໂຄຣໄນ fork ແລະ ສຳເນົາໃນເຄື່ອງຜ່ານ terminal ກໍໄດ້:

  1. ກວດເບິ່ງໃຫ້ແນ່ໃຈວ່າບໍ່ມີການປ່ຽນແປງທີ່ຄ້າງຢູ່ໂດຍການລັນ git status ແລ້ວລັນ git checkout master.

  2. ກວດເບິ່ງ remote repositories ຂອງເຈົ້າ: git remote -v. ເຈົ້າຄວນເຫັນຢ່າງໜ້ອຍ origin (fork ຂອງເຈົ້າ). ຖ້າບໍ່ມີ upstream, ໃຫ້ເພີ່ມມັນໃນຂັ້ນຕອນຕໍ່ໄປ.

  3. ເພີ່ມຄັງເກັບ dtdocs ເປັນ upstream (ເຮັດພຽງຄັ້ງດຽວ): git remote add upstream https://github.com/darktable-org/dtdocs.git.

  4. Pull ສະຖານະປັດຈຸບັນຈາກຄັງເກັບຫຼັກມາຍັງສຳເນົາໃນເຄື່ອງ: git pull upstream master.

  5. Push ສຳເນົາໃນເຄື່ອງທີ່ຊິງໂຄຣໄນແລ້ວໄປທີ່ fork ຂອງເຈົ້າ: git push origin master.

🔗ການສ້າງ Branch, ແກ້ໄຂ ແລະ ສ້າງ pull request

  1. ເປີດ terminal ຫຼື cmd ໃນໂຟນເດີຄັງເກັບເອກະສານ darktable ຂອງເຈົ້າ.

  2. ລັນ git pull origin master ເພື່ອດຶງການປ່ຽນແປງຫຼ້າສຸດຈາກ GitHub.

  3. ລັນ git checkout -b branch-name ໂດຍປ່ຽນ branch-name ເປັນຊື່ branch ທີ່ເຈົ້າຕ້ອງການ. ໂດຍທົ່ວໄປຄວນຕັ້ງຊື່ໃຫ້ກ່ຽວຂ້ອງກັບວຽກທີ່ເຈົ້າເຮັດ. ຕົວຢ່າງ, ສຳລັບ PR ນີ້ https://github.com/darktable-org/darktable/pull/17589 ເຈົ້າອາດຈະຕັ້ງຊື່ວ່າ dt-synch-edit-docs.

  4. ເລີ່ມເຮັດວຽກກ່ຽວກັບເອກະສານ.

  5. ກວດສອບໄຟລ໌ທີ່ເຈົ້າປ່ຽນແປງດ້ວຍ git status. ຖ້າເຈົ້າມີໄຟລ໌ທີ່ຖືກແກ້ໄຂຫຼາຍກວ່າທີ່ຕັ້ງໃຈຈະສົ່ງ, ເຈົ້າສາມາດໃຊ້ git restore path/to/file/ ເພື່ອຍົກເລີກການປ່ຽນແປງໃນໄຟລ໌ນັ້ນ.

  6. ລັນ git add -A. ສິ່ງນີ້ຈະ stage ໄຟລ໌ທີ່ປ່ຽນແປງທັງໝົດ.

  7. ລັນ git commit -m "Added documentation for yada yada". ພາຍໃນເຄື່ອງໝາຍ "" ໃຫ້ໃສ່ຂໍ້ຄວາມສັ້ນໆກ່ຽວກັບວຽກທີ່ເຈົ້າໄດ້ເຮັດ.

  8. ລັນ git push --set-upstream origin branch-name ໂດຍປ່ຽນ branch-name ເປັນຊື່ທີ່ເຈົ້າເລືອກໄວ້ກ່ອນໜ້ານີ້.

  9. ສ້າງ pull request ຂອງເຈົ້າໂດຍປະຕິບັດຕາມຄຳແນະນຳດ້ານລຸ່ມ.

  10. ຖ້າເຈົ້າຕ້ອງການແກ້ໄຂເພີ່ມເຕີມໃນ branch ເດີມ, ໃຫ້ເຮັດຂັ້ນຕອນ 3-8 ຊ້ຳຄືນ. ໃນຂັ້ນຕອນທີ 3 ເຈົ້າສາມາດຂ້າມ -b ໄປໄດ້ ແລະ ໃນຂັ້ນຕອນທີ 8 ເຈົ້າສາມາດລັນພຽງແຕ່ git push.

  11. ຫຼັງຈາກທີ່ເຈົ້າເຮັດສຳເລັດແລ້ວ ແລະ pull request ຂອງເຈົ້າຖືກ merge ຫຼື ເຈົ້າສຳເລັດວຽກສຳລັບ pull request ນັ້ນແລ້ວ, ໃຫ້ລັນ git checkout master ເພື່ອກັບໄປທີ່ master branch. ຂ້ອຍແນະນຳໃຫ້ເຮັດວຽກພຽງເທື່ອລະ branch/pr ຖ້າເຈົ້າຍັງບໍ່ຊຳນານໃນການໃຊ້ git.

🔗ການລັນ hugo ໃນເຄື່ອງເພື່ອເບິ່ງການປ່ຽນແປງ

hugo ສາມາດລັນໃນເຄື່ອງໄດ້ເພື່ອສ້າງຕົວຢ່າງການສະແດງຜົນ (preview) ຂອງເອກະສານ. ສິ່ງນີ້ມີປະໂຫຍດໃນການກວດສອບຮູບແບບ, ລິ້ງ ແລະ ອື່ນໆ.

ລັນ hugo server -D --disableFastRender ຈາກໂຟນເດີຫຼັກຂອງຄັງເກັບໃນເຄື່ອງຂອງເຈົ້າ. ຖ້າບໍ່ມີຂໍ້ຜິດພາດ, terminal ຈະແຈ້ງວ່າ: Web Server is available at http://localhost:1313/usermanual/development/ (bind address 127.0.0.1) ແລະ ເຈົ້າສາມາດເບິ່ງເວັບໄຊໄດ້ຕາມ URL ນັ້ນ. Hugo ຈະຄອຍກວດສອບການປ່ຽນແປງໃນໂຟນເດີ ແລະ ຈະອັບເດດໜ້າເວັບໃຫ້ໂດຍອັດຕະໂນມັດເມື່ອມີການແກ້ໄຂໄຟລ໌. ເມື່ອເຈົ້າເປີດໜ້າໃດໜຶ່ງໄວ້ ແລະ ມີການແກ້ໄຂໄຟລ໌ .md ທີ່ກ່ຽວຂ້ອງ, ບຣາວເຊີກໍຈະໂຫຼດໜ້ານັ້ນໃໝ່ໃຫ້ເອງຫຼັງຈາກ Hugo ອັບເດດແລ້ວ.

🔗Pull request

  1. ໄປທີ່ https://github.com/darktable-org/dtdocs/compare

  2. ກົດ compare across forks. ເລືອກ repository ຂອງເຈົ້າ, ແລ້ວເລືອກ branch ທີ່ເຈົ້າຫາພ້ອມແກ້ໄຂ.

  3. ກົດ Create Pull Request

translations