Adds JPG files (in doc dir) to CODEOWNERS
What does this MR do?
As part of reviewing Add documentation for Kibana Error budgets dash... (!114416 - merged), I approved, but my approval wasn't enough. That was odd, because both files were in the doc/development/
tree.
My thought process:
- Was it age? If yes, a rebase would have fixed it. (It didn't.)
- Was it content? I stared at the file listing for a moment and zeroed in on the JPG file. We don't use those often.
Sure enough, we forgot to declare JPG images in the doc/
directory as being approvable by technical writers:
## Files that are excluded from required approval
/.gitlab/issue_templates/*.md
/.gitlab/merge_request_templates/*.md
/doc/*.md
/doc/**/*.md
/doc/**/*.png
/data/deprecations/*.yml
/data/removals/**/*.yml
Let's fix this issue. To me it's an obvious oversight. Adding devopscreate and groupsource code because I was working a merge request for them when I stumbled into this problem.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.