Set docs.gitlab.com as the default help page
What does this MR do and why?
Sets docs.gitlab.com as the default help page.
This is a step towards the Technical Writing team's goal of improving the /help
experience for GitLab users. Epic here:
&7738 (this MR is step 5 under "Initial steps").
Closes #350671 (closed)
Screenshots or screen recordings
Settings page on a new installation. In the Before version, "https://docs.gitlab.com" is just placeholder text. In the After version, it is the actual field value.
Before | After |
---|---|
![]() |
![]() |
The "learn more" link on the settings page above redirects to:
Before | After |
---|---|
![]() |
![]() |
How to set up and validate locally
- Reset your installation:
gdk reset-data
- Log in and visit the Settings > Preferences page: http://localhost:3000/admin/application_settings/preferences
- Verify that the "Documentation pages URL" field under "Sign-in and Help page" is set to
https://docs.gitlab.com
by default. - Verify that help links within the product (like the "learn more" links in the settings area) open the appropriate documentation on the docs.gitlab.com website.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Related to #350671 (closed)
Edited by Sarah German