Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2022-05-24 00:59:06 +0300
committerSarah German <sgerman@gitlab.com>2022-05-24 00:59:06 +0300
commit22a0b17c554257cab932c0b825fe44fb8575228e (patch)
tree3577cbc9b14f185fca7dc7653a6c37a525860362
parentc2885834883207fa95987b1aab5aeb43b5b1a8f3 (diff)
Document how to run a fully-versioned Docs site locally
-rw-r--r--doc/development.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/development.md b/doc/development.md
index 52ce70fc..640b581e 100644
--- a/doc/development.md
+++ b/doc/development.md
@@ -106,6 +106,40 @@ If you would like to track that information, add the following parameters to the
`https://about.gitlab.com/pricing?=glm_source=docs.gitlab.com&glm_content=name-of-item-docs`
+## Run a fully-versioned Docs site locally
+
+You can run the following bash script to fetch all the versions that appear in
+the dropdown and have a fully-versioned site like the one in production.
+
+Prerequisites:
+
+- You must have Docker or another compatible container runtime installed.
+- For Linux users, to run the `docker` CLI command as a non-root user,
+ add your user to the `docker` user group, re-login, and restart
+ `docker.service`.
+
+Edit the `versions` array to match that of the dropdown:
+
+```shell
+#!/bin/bash
+versions=( 15.0 14.10 14.9 13.12 )
+for i in "${versions[@]}"
+do
+ docker create -it --name gitlab-docs-$i registry.gitlab.com/gitlab-org/gitlab-docs:$i
+ docker cp gitlab-docs-$i:/usr/share/nginx/html/$i public/
+ docker rm -f gitlab-docs-$i
+done
+```
+
+### MacOS Docker considerations
+
+- Due to licensing restrictions, consider an alternative to Docker Desktop. There are several suggestions in [the handbook](https://about.gitlab.com/handbook/tools-and-tips/mac/#docker-desktop). Colima works well with the above script.
+- M1 Macs require an environment variable in order to run these images:
+
+ ```shell
+ export DOCKER_DEFAULT_PLATFORM=linux/amd64
+ ```
+
## Add a new product
NOTE: