Commit 7c9fc4b0 authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Craig Norris

Re-did the feature flag details

parent 6a1d05d4
......@@ -61,14 +61,12 @@ You can specify a custom URL to which users are directed when they:
## Redirect GitLab documentation links
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43157) in GitLab 13.5.
> - [Deployed behind a feature flag](../../feature_flags.md), disabled by default.
> - Enabled on GitLab.com.
> - Ready for production use.
> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-gitlab-documentation-link-redirects). **(FREE SELF)**
> - Enabled on GitLab.com and is ready for production use. Available to GitLab.com administrators only.
This in-development feature might not be available for your use. There can be
[risks when enabling features still in development](../../../administration/feature_flags.md#risks-when-enabling-features-still-in-development).
Refer to this feature's version history for more details.
NOTE:
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to
[enable the `:help_page_documentation_redirect` flag](../../../administration/feature_flags.md).
On GitLab.com, this feature is available but can be configured by GitLab.com administrators only.
Documentation links go to the `/help` section on the instance by default, but you can
redirect these links to an external documentation site like `https://docs.gitlab.com`:
......@@ -78,25 +76,6 @@ redirect these links to an external documentation site like `https://docs.gitlab
1. Enter the URL in the **Documentation pages URL** field.
1. Select **Save changes**.
### Enable or disable GitLab documentation link redirects **(FREE SELF)**
The GitLab documentation link redirects feature is under development and not ready
for production use. It is deployed behind a feature flag that is **disabled by default**.
[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
can enable it.
To enable it:
```ruby
Feature.enable(:help_page_documentation_redirect)
```
To disable it:
```ruby
Feature.disable(:help_page_documentation_redirect)
```
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment