Skip to content

[2025-10] Monthly Handbook Maintenance Tasks

Reminder: Typically, all maintenance MRs should have the current milestone, and be labelled with HandbookOperations typemaintenance and other labels as appropriate.

Documentation: https://handbook.gitlab.com/docs/development/maintenance/

Note: Please check and make sure that basic functionality like nav bar, left nav tree, right table of contents, and heading links work when updating the Docsy theme.

General tasks

  1. Set the Due date to the last working day of this month
  2. Set the milestone to the one corresponding to the due date

Content tasks

  1. Codeowners check
    • Handbook
    • Internal handbook
  2. Compress images
    • Handbook
    • Internal handbook
    • Docsy-theme
  3. Check for unlinked images
    • Handbook
    • Internal handbook
  4. Check for broken external links
    • Handbook
    • Internal handbook
    • Docsy-theme
  5. Check for broken internal links
    • Handbook
  6. Check for product docs linter rules changes
  7. Run linters to double check errors are not being introduced
    • markdownlint
      • Handbook
      • Internal handbook
    • vale
      • Handbook
      • Internal handbook
  8. Merge vale spelling exception files
    • Handbook
    • Internal handbook
    • Docsy
  9. Fix trailing spaces
    • Handbook
    • Internal handbook
  10. Check for expired redirects
  • Handbook
  • Internal handbook
  1. Add "other" tasks as necessary

Backend tasks

  1. Docsy - Review/bump dependencies version:

    • Go tidy
    • golang
    • hugo
    • nodejs, including package dependencies
    • markdownlint
    • vale
  2. Handbook - Review/bump dependencies version:

    • Go tidy
    • golang
    • hugo
    • nodejs, including package dependencies
    • markdownlint
    • vale
  3. Internal handbook - Review/bump dependencies version:

    • Go tidy
    • golang
    • hugo
    • nodejs, including package dependencies
    • markdownlint
    • vale
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information