Skip to content

Fix link to self-hosted docs in sidebar help menu

Thomas Hutterer requested to merge 415316-redirect-to-docs-base into master

What does this MR do and why?

This adds a new route /help/docs that redirects to the landing page of our docs and uses this new route to fix the Help / Documentation link in our left sidebar.

Before this MR, the link always pointed to docs.gitlab.com, and ignored the Admin setting for self-hosted docs pages. This is especially problematic for air-gapped GitLab installation where users cannot access docs.gitlab.com.

See #415316 (comment 1859841175) for more context.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

How to set up and validate locally

  • Optional: Set up GitLab Docs in GDK.
  • Set your GDK gitlab-docs URL (https://gdk.test.:3005 by default) as Documentation pages URL in Sign-in and Help page... or any other URL if docs aren't set up in your GDK.
  • Now click the Help menu on the bottom of the left sidebar and click Documentation.
  • This should redirect you now to the URL you set above.
  • Undo the custom docs URL in your Admin Area and double-check that clicking the Documentation link now brings you to docs.gitlab.com.

Related to #415316 (closed)

Edited by Thomas Hutterer

Merge request reports