Research adding linting rules for release post items

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem to solve

Can any of the manual checks the technical writers perform on release post items be automated?

The current list is available at https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/.gitlab/merge_request_templates/Release-Post-Item.md

Examples:

  • Length of title field
  • Single quotes around link field
  • Double quotes around the title field
  • (others?)

The release post items are YAML files, which would imply using yamllint, but based on @aqualls' reading of the yamllint rules (https://yamllint.readthedocs.io/en/stable/rules.html) it looks like quotation marks may be all-or-nothing in a way that causes more disruption than help.

Consider if there are other ways some of the items could be automated to help eliminate manual checks and increase self-service for PMs.

cc @cnorris

Further details

Proposal

Who can address the issue

Other links/references

Edited by 🤖 GitLab Bot 🤖