Skip to content

Draft: Build rule to test for 'child' usage

Amy Qualls requested to merge aqualls-child-test into master
  • Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.

What does this MR do?

In !154132 (merged), Marcin introduced guidance for the word child. Wanted to see if I could get a test built for it. It's currently not working, and if I don't drop this idea into a merge request now, it'll get lost in a haze of meetings.

Right now, does it work?

  • hahahahahaha absolutely not.
  • it's still set to error for easier testing
  • https://vale.sh/docs/topics/styles/#sequence might be a useful approach? I don't think we've done a sequence rule before, and if we're looking for nouns…

tl;dr lots left to think about

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports