Skip to content

docs - Updates for maintaining consistency in language #215683

What does this MR do?

In response to the Virtual Workshop, "Everyone can contribute", @johncoghlan and @rpaik created #215683 (closed) to enable new contributors to get hands-on experience with the process.

One of the suggested contributions was:

  • In the Get started section, the sub-bullet for issues workflow should read "Issues workflow(link) for more information on:". Same for "Merge requests workflow(link) for more information on:". This is to make it consistent with other sections of the document (e.g. under "Must-reads:").

This MR satisfies the above request.

Related issues

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 Diego M. Perilla

Merge request reports