Skip to content

Approvals page: explain self-approval, cut wordiness

Amy Qualls requested to merge 464648-aqualls-self-approved into master
  • Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.

What does this MR do?

In #464648 (closed), I need to document that we've added an extra cue so users can tell at a glance if they've personally approved a merge request:

CleanShot_2024-05-31_at_10.12.08

There wasn't a really good place in https://docs.gitlab.com/ee/user/project/merge_requests/approvals/ for this. I started scrubbing text a bit, looking for ways to reshape the text. This MR definitely isn't done yet, but I'm unsure if I've hit MVC or not. I'll send it over to Marcin, take advantage of time zones, and get his thoughts. Iterate? Merge this first part? I think it's a little half-baked but he might disagree!

(The way I know it's not 100% done: I need to explain the various icons shown in the right sidebar of merge requests, and I've tackled only the merge request list.)

I've kicked off a review app.

Related issues

Related to Document icon usage in Code Review (#464648 - closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports

Loading