Skip to content

Docs: Removed screenshot in Merge Request topic

Suzanne Selhorn requested to merge selhorn-mr-edits into master

What does this MR do?

This MR:

  • Removes the screenshot in the Merge Request topic. This particular screenshot is very small and hard to read. Screenshots like this are also hard to keep updated, and if we localize, would be expensive to localize. When users need help, they come to the docs, and they don't want to have to scroll past a big screenshot.

  • Re-writes/edits the intro. It removes some language that was vague (the basis of GitLab as a code collaboration and version control platform) or tricky to understand (visualize and collaborate on the proposed changes to source code that exist as commits on a given Git branch).

  • It removes the word "allow" and uses uppercase to introduce the term and lowercase for the next sentence. Previously it was a mix of cases. This is an MVC and if a decision is made on capitalization, this part can be revisited.

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.

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