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
path: root/doc
diff options
context:
space:
mode:
authorMarcin Sedlak-Jakubowski <msedlakjakubowski@gitlab.com>2021-12-06 02:00:11 +0300
committerEvan Read <eread@gitlab.com>2021-12-06 02:00:11 +0300
commit25b5c015a3f99bdf9f0d28c0a995e0ead451e74e (patch)
tree7497d6bf6e63e7170a66a3552f9e6418f5604d27 /doc
parentfbfb9ffea92708f1bae297d55cf83cc0f8ffdbd3 (diff)
Improve docs release instructions
Diffstat (limited to 'doc')
-rw-r--r--doc/releases.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/releases.md b/doc/releases.md
index 45949cef..89fe54db 100644
--- a/doc/releases.md
+++ b/doc/releases.md
@@ -49,7 +49,7 @@ To minimize problems during the documentation release process, use the following
1. [Update the three online versions](#update-dropdown-for-online-versions), so that they display the new release on their
version dropdown menus.
-- On the 22nd of the month:
+- On the 22nd of the month, after the release post is live:
[Merge the release merge requests and run the necessary Docker image builds](#merge-merge-requests-and-run-docker-image-builds).
@@ -77,16 +77,30 @@ For example, see [the 13.9 release pipeline](https://gitlab.com/gitlab-org/gitla
If the pipeline fails, the new Docker image is not created and so not added to the registry.
-Optionally, you can test locally by:
+### Optional. Test locally
-1. Building the image and running it. For example, for GitLab 13.9 documentation:
+Prerequisite:
+
+- Install Docker. To verify, run `which docker`.
+
+1. Build the image and run it. For example, for GitLab 13.9 documentation:
```shell
docker build -t docs:13.9 -f Dockerfile.13.9 .
docker run -it --rm -p 4000:4000 docs:13.9
```
-1. Visiting `http://localhost:4000/13.9` to see if everything works correctly.
+ If you get a permission error, try running the commands prefixed with `sudo`.
+
+ If you're informed that the Docker daemon isn't running, start it manually:
+
+ - (MacOS) `dockerd` ([read more](https://docs.docker.com/config/daemon/#start-the-daemon-manually)).
+ - (Linux) `sudo systemctl start docker` ([read more](https://docs.docker.com/config/daemon/systemd/#start-manually)).
+
+1. Visit `http://localhost:4000/13.9` to see if everything works correctly.
+1. Stop the Docker container:
+ 1. Identify the container's ID with `docker container ls`.
+ 1. Run `docker stop <container ID>`.
## Create release merge request
@@ -215,6 +229,8 @@ The steps should be updated when we move to the next major release (15.0).
## Merge merge requests and run Docker image builds
+_Do this after the release post is live._
+
The merge requests for the dropdowns should now all be merged into their respective stable branches.
1. Check the [pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/pipelines)