[Feature flag] Enable `help_page_documentation_redirect`
What
Remove the :help_page_documentation_redirect
feature flag
Issue: #32328 (closed)
This feature flag allows to control the rendering of the documentation pages.
In this merge request I've added an option to setup a base URL in Admin to documentation pages.
The next merge request enables redirects to documentation pages if the base URL is set.
Feature flag allows to control redirects behavior and fallback to the original implementation.
Owners
- Team: Static Site Editor
- Most appropriate slack channel to reach out to:
#g_create_static_site_editor
- Best individual to reach out to: @vyaklushin
Expectations
What are we expecting to happen?
When flag is enabled, then users will be redirected to docs.gitlab.com when they click on https://gitlab.com/help/ci/pipelines/job_artifacts.md (an example).
What might happen if this goes wrong?
If the flag does not work, then redirects will be disabled. It is a current behavior.
What can we monitor to detect problems with this?
Beta groups/projects
If applicable, any groups/projects that are happy to have this feature turned on early. Some organizations may wish to test big changes they are interested in with a small subset of users ahead of time for example.
-
gitlab-org/gitlab
project -
gitlab-org
/gitlab-com
groups - ...
Roll Out Steps
-
Enable on staging ( /chatops run feature set feature_name true --staging
) -
Test on staging (I don't have an admin access to reach Admin Area) -
Ensure that documentation has been updated -
Enable on GitLab.com for individual groups/projects listed above and verify behaviour ( /chatops run feature set --project=gitlab-org/gitlab feature_name true
) -
Coordinate a time to enable the flag with #production
and#g_delivery
on slack. -
Announce on the issue an estimated time this will be enabled on GitLab.com -
Enable on GitLab.com by running chatops command in #production
(/chatops run feature set feature_name true
) -
Cross post chatops Slack command to #support_gitlab-com
(more guidance when this is necessary in the dev docs) and in your team channel -
Announce on the issue that the flag has been enabled -
Update documentation, fix wording and descriptions to fields -
Remove feature flag and add changelog entry -
After the flag removal is deployed, clean up the feature flag by running chatops command in #production
channel