Skip to content

GitLab OmniAuth provider - update code snippet for changing GitLab URL

Anton Smith requested to merge docs/access-gitlab-provider-custom-url into master

What does this MR do?

The GitLab OmniAuth provider can be configured to point to another self-managed instance instead of GitLab.com as per the gem https://github.com/linchus/omniauth-gitlab#standalone-usage - however this document makes no mention of that.

This MR updates the code snippet to hint at how to customize the GitLab URL so we at least have a record of this somewhere. A more saavy person would see this and realise that the URL can be changed, if they wish to use their own self managed instance for the GitLab OmniAuth provider instead of GitLab.com.

The problem I have now is that this document is really focused on GitLab.com and I wasn't sure if I should go down the path of rewriting the doc so it applies to both GitLab.com and self-managed instances. Let me know what you think.

Related issues

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports