Skip to content

Fix links to instance-level approval settings

Amy Qualls requested to merge aqualls-repair-settings-links into master

What does this MR do?

In https://gitlab.slack.com/archives/C01EMBKS5DW/p1704463527673199, @leetickett-gitlab reported he was having trouble finding the instance-level config for MR approvals settings. He (correctly!) pointed out that links purporting to go to instance-level instructions were pointing to https://docs.gitlab.com/ee/administration/admin_area.html, which isn't the right page.

It tickled a memory, though. A few months ago, we moved a lot of pages in doc/user/admin_area/ to a new place in the doc/administration hierarchy. Was this related?

I found the instance-related lines in doc/user/project/merge_requests/approvals/settings.md and used git blame to walk backward to see what those lines previously linked to. Answer: doc/administration/merge_requests_approvals.md.

In !138223 (merged) the redirect for doc/user/admin_area/merge_requests_approvals.mddoc/administration/merge_requests_approvals.md was removed, and links to doc/administration/merge_requests_approvals.md were updated to the wrong place. It was pretty easy to reconstruct what had happened - a search + replace for merge_requests_approvals.md changed more links than it should've.

This MR corrects those links that were changed.

Related issues

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