Skip to content

Edited for CTRT and style

Suzanne Selhorn requested to merge selhorn-git-start-1 into master

What does this MR do?

This MR edits the topic to have clearer concepts and tasks. Some of the style edits I made were:

  • Removed "we"
  • Used numbered lists
  • Present tense
  • "In" instead of "within"
  • "Go" instead of "jump"
  • Removed some marketing language like "useful" or "helpful" or "powerful"
  • "Select" instead of "click"
  • Instead of "we advise against" said "you should not"
  • I brought the terms to the top so if you don't know what the words mean you can read them before the procedures. Probably should go in a separate topic, but leaving for now.

I also made a video to walk through the process I went through while editing: https://youtu.be/HehnjPgPWb0

Related issues

Related to: #327171 (closed)

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 Suzanne Selhorn

Merge request reports

Loading