diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2019-07-10 03:55:54 +0000 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2019-07-10 03:55:54 +0000 |
| commit | 8c44a7bcb528c3c670554a0c6a61d6d54a667e8e (patch) | |
| tree | 1286fff83f7ea53cbffa84d6998f79adb4e9fab6 | |
| parent | 8a33f51d2f5ce67e167deb21ffe7768c3d638dcf (diff) | |
| download | gitlab-ce-link-help-path-epic-in-dev-docs.tar.gz | |
Add link to epic for removing /helplink-help-path-epic-in-dev-docs
| -rw-r--r-- | doc/development/documentation/index.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index 418e58b22d5..cbdc0a3a174 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -18,7 +18,7 @@ In addition to this page, the following resources to help craft and contribute d ## Source files and rendered web locations -Documentation for GitLab Community Edition (CE) and Enterprise Edition (EE), along with GitLab Runner and Omnibus, is published to [docs.gitlab.com](https://docs.gitlab.com). The documentation for CE and EE is also published within the application at `/help` on the domain of the GitLab instance. +Documentation for GitLab Community Edition (CE) and Enterprise Edition (EE), along with GitLab Runner and Omnibus, is published to [docs.gitlab.com](https://docs.gitlab.com). The documentation for CE and EE is also published within the application at `/help` on the domain of the GitLab instance, though there are [plans](https://gitlab.com/groups/gitlab-org/-/epics/693) to end this practice and instead link out from the GitLab application to docs.gitlab.com URLs. At `/help`, only content for your current edition and version is included, whereas multiple versions' content is available at docs.gitlab.com. @@ -274,8 +274,11 @@ Follow this [method for cherry-picking from CE to EE](../automatic_ce_ee_merge.m ## GitLab `/help` -Every GitLab instance includes the documentation, which is available from `/help` -(`http://my-instance.com/help`), e.g., <https://gitlab.com/help>. +Every GitLab instance includes the documentation, which is available at `/help` +(`https://gitlab.example.com/help`). For example, <https://gitlab.com/help>. + +There are [plans](https://gitlab.com/groups/gitlab-org/-/epics/693) to end this +practice and instead link out from the GitLab application to docs.gitlab.com URLs. The documentation available online on docs.gitlab.com is continuously deployed every hour from the `master` branch of CE, EE, Omnibus, and Runner. Therefore, |