Add configuration option support for documentation pages
What does this MR do?
Contributes to #214164 (closed)
We want to introduce an option to configure documentation pages base
url via gitlab.yml file. That will allow us to provide custom
configurations for different distributions (Omnibus, source code
installation, etc.)
Steps to verify
Enable feature flag Feature.enable(:help_page_documentation_redirect)
Database configuration option
- Go to Admin area -> Settings -> Preferences
- Expand Help page section
- Verify that
Documentation pages URLis present - Check that the field can be updated and keeps the value
- Visit a help page (for example,
http://localhost:3000/help/user/index.md) - Check that browser redirects you to
<documentation_pages_url>/ee/user/index.html
Yaml configuration option
- Add
gitlab_docssection togitlab.ymlFor example,gitlab_docs: enabled: true host: 'https://docs.gitlab.com' - Restart the application
- Visit a help page (for example,
http://localhost:3000/help/user/index.md) - Check that browser redirects you to
<host>/ee/user/index.html
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Vasilii Iakliushin