Skip to content

Edited for style and consistency

Suzanne Selhorn requested to merge selhorn-ci-yaml-123 into master

What does this MR do?

This MR goes through the .gitlab-ci.yml file again to review for style inconsistencies.

Things I addressed:

  • Each of the high-level topics now starts with "Use blah to" rather than "Use the blah keyword" or other variations.
  • Active voice
  • If an example is below the text, I used "In the following example." If the example is above the text, I used "In this example." Sometimes I moved the descriptive text above the example.
  • Line 664 says support for this thing is planned, but the issue is 4 years old. We should never say something is planned but instead just say an issue exists.
  • Removed cases of "special" where I felt I could.
  • Searched and replaced "above"/"below" as much as possible.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

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

  • 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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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 Marcel Amirault

Merge request reports

Loading