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

Proposal: document all periodic maintenance tasks #12291

Open
vitorhcl opened this issue Feb 18, 2024 · 1 comment
Open

Proposal: document all periodic maintenance tasks #12291

vitorhcl opened this issue Feb 18, 2024 · 1 comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation.

Comments

@vitorhcl
Copy link
Member

vitorhcl commented Feb 18, 2024

Listing all mantainance tasks that need to be done from time to time would bring them more attention and also make them harder to forgot.

Also, it's a good opportunity to highlight them so someone can automate some of those tasks, or at least create helper scripts.

I think a good place for them is in the mantainer's guide.

Some of them are:

  • Check software updates (specially breaking changes)
  • Check broken links on all the documentation
  • Check broken links on more info links
  • Update the status of the clients on the wiki
  • Keep track of new clients
  • Update CONTRUBUTING.md or style guide to describe the current patterns over the pages
  • Update the list of collaborators and Org members
  • Update "Let's document" or eventually page/translation requests (yeah, this could be done by the issue owner, but I think there's room for automation when it comes to "Let's document" issues)
@vitorhcl vitorhcl added decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation. labels Feb 18, 2024
@kbdharun
Copy link
Member

kbdharun commented Feb 18, 2024

Thanks, this is an excellent proposal and I too think the maintainer's guide would be a good place to document this.

Edit. Maybe we could mention about https://github.com/tldr-pages/tldr-maintenance too.

@kbdharun kbdharun changed the title Proposal: document all periodic mantainance tasks Proposal: document all periodic maintenance tasks Mar 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation.
Projects
None yet
Development

No branches or pull requests

2 participants