Skip to content

June maintenance tasks

For June, please add tasks to this issue description and let the assignees know.

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

Content tasks

DRI: @cynthia

  1. Remove stale codeowners
  2. Fix trailing spaces
  3. Check for expired redirects: https://gitlab.com/gitlab-com/content-sites/docsy-gitlab/-/blob/main/layouts/index.redirects, https://gitlab.com/gitlab-com/content-sites/internal-handbook/-/blob/main/layouts/index.redirects, and https://gitlab.com/gitlab-com/content-sites/handbook/-/blob/main/layouts/index.redirects | https://gitlab.com/gitlab-com/content-sites/internal-handbook/-/merge_requests/4931 and !6562 (merged)
  4. Check for broken external links
  5. Check for product docs linter rules changes
  6. Run linters to double check errors are not being introduced
    • markdownlint: markdownlint-cli2 "content/**/*.md" "assets/**/*.md" "layouts/**/*.md"
      • Public handbook (no errors)
      • Internal handbook (no errors)
    • vale: vale --no-wrap --minAlertLevel error --glob='{content,assets,layouts}/**/*.md' .
      • Public handbook (no errors)
      • Internal handbook (no errors)
  7. Check for unlinked images by running unlinked-images.sh.
  8. Under consideration: Check and compress images using https://pngquant.org/ with something like find . -name '*.png' -print0 | xargs -0 -P8 -L1 pngquant --ext .png --force 256
    • Public handbook
    • Internal handbook

Backend tasks

DRI: @darbyfrey

  1. Review/bump dependencies version:
  2. Go tidy job: !6413 (diffs) | Note: The tidy job is still run in the docsy pipeline, so most likely you only need to do it for handbook and internal-handbook if it pops up as an issue in the docsy-theme pipeline.
  3. Upgrade dependencies in Docsy Gitlab
  4. Upgrade dependencies in Handbook
  5. Upgrade dependencies in Internal Handbook
Edited by Cynthia "Arty" Ng
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information