ປະກອບສ່ວນເຂົ້າໃນເອກະສານຂອງ Weblate

ທ່ານສາມາດປັບປຸງໜ້າເອກະສານໃດກໍໄດ້ຕາມທີ່ທ່ານຕ້ອງການ. ເຮັດໄດ້ງ່າຍໆໂດຍການຄລິກປຸ່ມ Edit on GitHub ທີ່ມຸມຂວາເທິງຂອງໜ້າ.

ຂໍ້ແນະນຳດ້ານເອກະສານ

ກະລຸນາປະຕິບັດຕາມຂໍ້ແນະນຳເຫຼົ່ານີ້ໃນຂະນະຂຽນ:

  1. ຢ່າລຶບສ່ວນໃດໜຶ່ງຂອງເອກະສານຖ້າມັນຍັງຖືກຕ້ອງຢູ່.

  2. ໃຊ້ພາສາທີ່ຊັດເຈນ ແລະ ເຂົ້າໃຈງ່າຍ. ທ່ານກຳລັງຂຽນເອກະສານທາງເຕັກນິກ, ບໍ່ແມ່ນບົດກະວີ. ຜູ້ອ່ານເອກະສານບໍ່ແມ່ນທຸກຄົນທີ່ເປັນເຈົ້າຂອງພາສາ, ຈົ່ງຄຳນຶງເຖິງຈຸດນີ້.

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

  4. ກວດສອບການປ່ຽນແປງຂອງທ່ານໂດຍການເຮັດຕາມຂັ້ນຕອນທີ່ອະທິບາຍໄວ້ໃນເອກະສານ.

  5. ສົ່ງ PR ທີ່ມີການປ່ຽນແປງເປັນສ່ວນຍ່ອຍໆ ເພື່ອໃຫ້ການກວດສອບ ແລະ ການລວມ (merge) ງ່າຍຂຶ້ນ ແລະ ໄວຂຶ້ນ.

  6. ຖ້າທ່ານຕ້ອງການຂຽນຄືນໃໝ່ ແລະ ປ່ຽນໂຄງສ້າງຂອງບົດຄວາມໃຫຍ່ໆ, ໃຫ້ເຮັດໃນສອງຂັ້ນຕອນ:

    1. ຂຽນຄືນໃໝ່

    2. ເມື່ອການຂຽນຄືນໃໝ່ໄດ້ຮັບການກວດສອບ, ປັບແຕ່ງ, ແລະ ລວມເຂົ້າກັນແລ້ວ, ໃຫ້ປ່ຽນໂຄງສ້າງຂອງວັກຕ່າງໆໃນ PR ອີກອັນໜຶ່ງ.

ການສ້າງເອກະສານໃນເຄື່ອງຂອງທ່ານ (Locally)

ເອກະສານສາມາດຖືກແກ້ໄຂ ແລະ ສ້າງໃນເຄື່ອງຂອງທ່ານໄດ້, ຄວາມຕ້ອງການດ້ານ Python ຈະຢູ່ໃນກຸ່ມຄວາມຕ້ອງການ docs ໃນ pyproject.toml. ຖ້າທ່ານໃຊ້ສະພາບແວດລ້ອມການພັດທະນາເຕັມຮູບແບບແລ້ວ, uv sync --all-extras --dev ກໍພຽງພໍແລ້ວ. ສຳລັບການເຮັດວຽກດ້ານເອກະສານເທົ່ານັ້ນ, uv sync --group docs ກໍພຽງພໍ.

ຂັ້ນຕອນການເຮັດວຽກໃນເຄື່ອງທີ່ແນະນຳແມ່ນ:

make -C docs update-docs
./ci/run-docs

ຕົວຄຸມ ci/run-docs ຈະສ້າງເອກະສານໂດຍຖືວ່າຄຳເຕືອນຕ່າງໆແມ່ນຂໍ້ຜິດພາດ.

CI documentation, release notes, and linkcheck builds reuse cached intersphinx inventories. The Intersphinx inventories workflow refreshes them daily and can also be run manually from GitHub Actions on the default branch. Failed refreshes retain the last valid inventories and are reported as workflow failures.

Inventories are stored in docs/_build/intersphinx. Builds use upstream inventories when a local copy is missing, including after CI cache eviction or when adding an inventory URL. Local and Read the Docs builds do not require the cache. To refresh local copies for all documentation languages, run:

languages=$(uv run --no-project scripts/list-documentation-languages.py)
uv run python docs/_ext/intersphinx_cache.py --languages "${languages#languages=}"

The inventory cache does not eliminate network requests for checking destination pages during linkcheck builds.

Hint

ທ່ານຈະຕ້ອງຕິດຕັ້ງ graphviz ເພື່ອສ້າງເອກະສານ.

ການແປເອກະສານ

ທ່ານສາມາດ ແປເອກະສານ ໄດ້.

ການອັບເດດສ່ວນເອກະສານທີ່ສ້າງຂຶ້ນໂດຍອັດຕະໂນມັດ

ຫຼາຍພາກສ່ວນຂອງເອກະສານໃຊ້ແມ່ແບບທີ່ສ້າງຂຶ້ນຈາກລະຫັດ. ວິທີທີ່ແນະນຳໃນການເຮັດໃຫ້ມັນທັນສະໄໝຄື:

make -C docs update-docs

ເປົ້າໝາຍນີ້ຈະສ້າງ snippet ໃໝ່ທີ່ໃຊ້ໃນປັດຈຸບັນໂດຍເອກະສານ, ລວມເຖິງ:

  • ເຫດການ Add-on, Add-on ທີ່ຕິດຕັ້ງມາພ້ອມ, ແລະ ພາລາມິເຕີທົ່ວໄປຂອງ Add-on

  • ບໍລິການແປພາສາດ້ວຍເຄື່ອງຈັກ

  • ພາລາມິເຕີຮູບແບບໄຟລ໌ ແລະ ຕາຕະລາງຟີເຈີຮູບແບບໄຟລ໌

  • ການອະນຸຍາດ ແລະ ບົດບາດທີ່ຕິດມາພ້ອມ

  • ການກວດສອບ ແລະ ທຸງການກວດສອບ

ຮັກສາຂໍ້ຄວາມທີ່ດູແລດ້ວຍຕົນເອງໄວ້ໃນໜ້າເອກະສານຫຼັກ ແທນທີ່ຈະເພີ່ມມັນໃສ່ snippet ທີ່ສ້າງຂຶ້ນອັດຕະໂນມັດ. ຕົວຢ່າງ: ສ່ວນເສີມ ລວມມີສາມໄຟລ໌ທີ່ສ້າງຂຶ້ນສຳລັບເຫດການ, Add-on ທີ່ຕິດມາພ້ອມ, ແລະ ພາລາມິເຕີ Add-on ທົ່ວໄປ, ໃນຂະນະທີ່ Add-on ທີ່ບໍ່ໃຊ້ແລ້ວຈະຖືກດູແລໂດຍກົງໃນໜ້ານັ້ນ.

ຖ້າທ່ານຕ້ອງການສ້າງໃໝ່ພຽງສ່ວນດຽວ, ຄຳສັ່ງຈັດການແຕ່ລະອັນຖືກບັນທຶກໄວ້ໃນ ຄຳສັ່ງຈັດການ, ແລະ ຄຳສັ່ງທີ່ແນ່ນອນທີ່ update-docs ໃຊ້ຈະຢູ່ໃນ docs/Makefile.