mirrorz-org/mirrorz-help

feat: add hook for updating documentation automatically

Opened this issue · 3 comments

ricky9w commented

特性描述 (Feature Description)

When the content of the mirror repo is updated, the documentation also needs to be updated to match the latest changes in the repository.

Outdated help documents might cause some inconvenience or even mislead users. However, manually updating the documentation can be cumbersome and may not be timely. For example:

  • When Debian, Ubuntu, etc., release new major versions, the documentation needs to include the corresponding version options.
  • For Arch Linux, at the beginning of every month when a new build is released, it is necessary to reset the latest link, among other things.

Considering that the help documentation is generally structured, creating a hook to automatically update the documentation when the repository content changes seems feasible.

ZenithalHourlyRate commented

For Arch Linux, at the beginning of every month when a new build is released, it is necessary to reset the latest link, among other things.

https://geo.mirror.pkgbuild.com/iso/latest/archlinux-x86_64.iso and https://geo.mirror.pkgbuild.com/images/latest/Arch-Linux-x86_64-cloudimg.qcow2 are symlinks to the latest builds.

  • 👀1
eastonman commented

Although writing hooks for updating documents seems feasible, I want to raise a few things.

  1. Document difference between major releases exists, which causes issues whether using scripts or not.
  2. Major version changes are relatively rare.
ricky9w commented

Although writing hooks for updating documents seems feasible, I want to raise a few things.

  1. Document difference between major releases exists, which causes issues whether using scripts or not.

  2. Major version changes are relatively rare.

Maybe take a step back, hooks that just raise notifications, so that maintainers can check if the documentation needs updates in time?