Skip to content

Updated "Creating issue templates" section

Nuritzi Sanchez requested to merge patch-113 into master

To find the designated Tech Writer for the stage/group, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers

FYI -- this link is now: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments.

What does this MR do?

This MR proposes a change to the documentation on how to create issue templates. Especially for non-engineering folk, it may not be obvious that if they don't already have a .gitlab/issue_templates directory, that they can/should create one. When I went through the process, I also ran into issues using hyphens instead of underscores, so I added a clarification there too.

Lastly, if you're not already familiar with creating .md files, it's not intuitive how to do so. I added steps for that as well.

Related issues

N/A

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcin Sedlak-Jakubowski

Merge request reports