summaryrefslogtreecommitdiff
path: root/doc/administration/docs_self_host.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-05-17 16:05:49 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2023-05-17 16:05:49 +0000
commit43a25d93ebdabea52f99b05e15b06250cd8f07d7 (patch)
treedceebdc68925362117480a5d672bcff122fb625b /doc/administration/docs_self_host.md
parent20c84b99005abd1c82101dfeff264ac50d2df211 (diff)
downloadgitlab-ce-43a25d93ebdabea52f99b05e15b06250cd8f07d7.tar.gz
Add latest changes from gitlab-org/gitlab@16-0-stable-eev16.0.0-rc4216-0-stable
Diffstat (limited to 'doc/administration/docs_self_host.md')
-rw-r--r--doc/administration/docs_self_host.md43
1 files changed, 22 insertions, 21 deletions
diff --git a/doc/administration/docs_self_host.md b/doc/administration/docs_self_host.md
index 97eff35da91..d1ad36880dd 100644
--- a/doc/administration/docs_self_host.md
+++ b/doc/administration/docs_self_host.md
@@ -22,7 +22,7 @@ To host the GitLab product documentation, you can use:
- GitLab Pages
- Your own web server
-After you create a website by using one of these methods, you redirect the UI links
+After you create a website by using one of these methods, redirect the UI links
in the product to point to your website.
NOTE:
@@ -41,7 +41,7 @@ In the following example, we expose this on the host under the same port.
Make sure you either:
- Allow port `4000` in your firewall.
-- Use a different port. In following examples, replace the leftmost `4000` with the port different port.
+- Use a different port. In following examples, replace the leftmost `4000` with a different port number.
To run the GitLab product documentation website in a Docker container:
@@ -74,9 +74,9 @@ To run the GitLab product documentation website in a Docker container:
docker-compose up -d
```
-1. Visit `http://0.0.0.0:4000` to view the documentation website and verify
+1. Visit `http://0.0.0.0:4000` to view the documentation website and verify that
it works.
-1. [Redirect the help links to the new Docs site](#redirect-the-help-links-to-the-new-docs-site).
+1. [Redirect the help links to the new documentation site](#redirect-the-help-links-to-the-new-docs-site).
### Self-host the product documentation with GitLab Pages
@@ -84,7 +84,7 @@ You can use GitLab Pages to host the GitLab product documentation.
Prerequisite:
-- Ensure the Pages site URL does not use a subfolder. Because of how the docs
+- Ensure the Pages site URL does not use a subfolder. Because of the way the
site is pre-compiled, the CSS and JavaScript files are relative to the
main domain or subdomain. For example, URLs like `https://example.com/docs/`
are not supported.
@@ -114,13 +114,13 @@ To host the product documentation site with GitLab Pages:
| [Project website](../user/project/pages/getting_started_part_one.md#project-website-examples) | Not supported | Supported |
| [User or group website](../user/project/pages/getting_started_part_one.md#user-and-group-website-examples) | Supported | Supported |
-1. [Redirect the help links to the new Docs site](#redirect-the-help-links-to-the-new-docs-site).
+1. [Redirect the help links to the new documentation site](#redirect-the-help-links-to-the-new-docs-site).
### Self-host the product documentation on your own web server
Because the product documentation site is static, you can take the contents of
`/usr/share/nginx/html` from inside the container, and use your own web server to host
-the docs wherever you want.
+the documentation wherever you want.
The `html` directory should be served as is and it has the following structure:
@@ -135,7 +135,7 @@ In this example:
- `index.html` is a simple HTML file that redirects to the directory containing the documentation. In this
case, `14.5/`.
-To extract the HTML files of the Docs site:
+To extract the HTML files of the documentation site:
1. Create the container that holds the HTML files of the documentation website:
@@ -158,36 +158,40 @@ To extract the HTML files of the Docs site:
```
1. Point your web server to serve the contents of `/srv/gitlab/html/`.
-1. [Redirect the help links to the new Docs site](#redirect-the-help-links-to-the-new-docs-site).
+1. [Redirect the help links to the new documentation site](#redirect-the-help-links-to-the-new-docs-site).
## Redirect the `/help` links to the new Docs site
After your local product documentation site is running,
[redirect the help links](../user/admin_area/settings/help_page.md#redirect-help-pages)
in the GitLab application to your local site, by using the fully qualified domain
-name as the docs URL. For example, if you used the
+name as the documentation URL. For example, if you used the
[Docker method](#self-host-the-product-documentation-with-docker), enter `http://0.0.0.0:4000`.
You don't need to append the version. GitLab detects it and appends it to
documentation URL requests as needed. For example, if your GitLab version is
14.5:
-- The GitLab Docs URL becomes `http://0.0.0.0:4000/14.5/`.
+- The GitLab documentation URL becomes `http://0.0.0.0:4000/14.5/`.
- The link in GitLab displays as `<instance_url>/help/user/admin_area/settings/help_page#destination-requirements`.
- When you select the link, you are redirected to
`http://0.0.0.0:4000/14.5/ee/user/admin_area/settings/help_page/#destination-requirements`.
-To test the setting, select a **Learn more** link in the GitLab application.
+To test the setting, in GitLab, select a **Learn more** link. For example:
+
+1. On the top bar, in the upper-right corner, select your avatar.
+1. Select **Preferences**.
+1. In the **Syntax highlighting theme** section, select **Learn more**.
## Upgrade the product documentation to a later version
-Upgrading the Docs site to a later version requires downloading the newer Docker image tag.
+Upgrading the documentation site to a later version requires downloading the newer Docker image tag.
### Upgrade using Docker
To upgrade to a later version [using Docker](#self-host-the-product-documentation-with-docker):
-- If you use plain Docker:
+- If you use Docker:
1. Stop the running container:
@@ -207,7 +211,7 @@ To upgrade to a later version [using Docker](#self-host-the-product-documentatio
docker run --detach --name gitlab_docs -it --rm -p 4000:4000 registry.gitlab.com/gitlab-org/gitlab-docs:14.6
```
-- If you use Docker compose:
+- If you use Docker Compose:
1. Change the version in `docker-compose.yaml`, for example 14.6:
@@ -231,19 +235,19 @@ To upgrade to a later version [using Docker](#self-host-the-product-documentatio
To upgrade to a later version [using GitLab Pages](#self-host-the-product-documentation-with-gitlab-pages):
-1. Edit your existing `.gitlab-ci.yml` file, and replace the `image`'s version number:
+1. Edit your existing `.gitlab-ci.yml` file, and replace the `image` version number:
```yaml
image: registry.gitlab.com/gitlab-org/gitlab-docs:14.5
```
-1. Commit the changes, push, and GitLab Pages pulls the new Docs site version.
+1. Commit the changes, push, and GitLab Pages pulls the new documentation site version.
### Upgrade using your own web-server
To upgrade to a later version [using your own web-server](#self-host-the-product-documentation-on-your-own-web-server):
-1. Copy the HTML files of the Docs site:
+1. Copy the HTML files of the documentation site:
```shell
docker create -it --name gitlab_docs registry.gitlab.com/gitlab-org/gitlab-docs:14.6
@@ -261,8 +265,5 @@ To upgrade to a later version [using your own web-server](#self-host-the-product
If you self-host the product documentation:
-- The version dropdown list displays additional versions that don't exist. Selecting
- these versions displays a `404 Not Found` page.
-- The search displays results from `docs.gitlab.com` and not the local site.
- By default, the landing page redirects to the
respective version (for example, `/14.5/`). This causes the landing page <https://docs.gitlab.com> to not be displayed.