Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add hook for updating documentation automatically #118

Open
ricky9w opened this issue Sep 4, 2023 · 3 comments
Open

feat: add hook for updating documentation automatically #118

ricky9w opened this issue Sep 4, 2023 · 3 comments

Comments

@ricky9w
Copy link

ricky9w commented Sep 4, 2023

特性描述 (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
Copy link
Collaborator

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.

@eastonman
Copy link
Member

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
Copy link
Author

ricky9w commented Sep 5, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants