Docs links on in-product help pages should use the "Documentation pages URL" setting
Some links on the built-in help page (https://gitlab.com/help) use absolute links that point to pages on docs.gitlab.com
.
Generally, docs links are relative so that they can work in both the built-in docs pages in /help
, and also on docs.gitlab.com
. However, some of the links on the page now cannot be relative because they point to pages that are not shipped with GitLab (docs for Omnibus, Runner, Charts, etc are not available locally for SM instances).
These links should either:
- Not exist on this page (if this epic is still accurate, this seems to be the direction we'd want to go here)
- Be redirected to the value of the user's "Documentation pages URL" setting in their self-managed instance.
A change to the link behavior would probably need to happen around here somewhere: https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/controllers/help_controller.rb
Edited by Sarah German