Skip to content

Proposal: document all periodic maintenance tasks #12291

Open
@vitorhcl

Description

@vitorhcl

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    decisionA (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc.documentationIssues/PRs modifying the documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions