Skip to content

Docs: Revise Crossplane page for tone and style

Amy Qualls requested to merge docs-aqualls-crossplane into master

What does this MR do?

Makes major changes to https://docs.gitlab.com/ee/user/clusters/crossplane.html to try to bring it closer to GitLab tone and style.

Major notes for the reviewer:

  1. Whenever possible, I tried to move procedures to ordered lists.
  2. I changed the format of the two largest code samples. Previously, they were both marked as shell because they were catting YAML information into a file. The syntax highlighting was useless this way. I've changed the instructions to say "create xyz.yaml" and put just the YAML file in a code block marked as yaml so syntax highlighting will work correctly.

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

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

Merge request reports