Skip to content

Commit acbd04c

Browse files
Fiona NeillJonathan Glassman
andcommitted
Merge branch 'stylefix-build-docker' into 'master'
Style fixes for build docker image docs See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6394 Merged-by: Fiona Neill <[email protected]> Approved-by: Fiona Neill <[email protected]> Co-authored-by: Jonathan Glassman <[email protected]>
2 parents 5d3231d + a5a315d commit acbd04c

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

doc/build/build_docker_image.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,33 @@ group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
55
---
66

7-
# Building an all-in-one GitLab Docker image locally
7+
# Build a GitLab Docker image locally
88

9-
The GitLab all-in-one Docker image uses Ubuntu 20.04 package created by
10-
`omnibus-gitlab` under the hood. The files required for building Docker image
11-
can be found inside the `Docker` directory of `omnibus-gitlab` repository,
12-
except `RELEASE` file which needs to be compiled manually, as described below.
9+
The GitLab Docker image uses the Ubuntu 20.04 package created by
10+
`omnibus-gitlab`. Most of the files needed for building a Docker image
11+
are in the `Docker` directory of the `omnibus-gitlab` repository.
12+
The `RELEASE` file is not in this directory, and you must create this file.
1313

14-
## RELEASE file
14+
## Create the `RELEASE` file
1515

16-
The details of the version of the package being used is stored in a file named
17-
`RELEASE`. To build your own Docker image, you should create this file with
18-
contents similar to the following
16+
The version details of the package being used are stored in the `RELEASE` file.
17+
To build your own Docker image, create this file with contents similar to the following.
1918

2019
```plaintext
2120
RELEASE_PACKAGE=gitlab-ee
2221
RELEASE_VERSION=13.2.0-ee
2322
DOWNLOAD_URL=https://example.com/gitlab-ee_13.2.00-ee.0_amd64.deb
2423
```
2524

26-
Here, `RELEASE_PACKAGE` specifies whether the package is a CE one or EE one.
27-
`RELEASE_VERSION` specifies the version of the package (`13.2.0-ee`,
28-
`12.9.2+rfbranch.150270.c43b3273-0`, etc.). `DOWNLOAD_URL` specifies the URL
29-
where that package can be downloaded from.
25+
- `RELEASE_PACKAGE` specifies whether the package is a CE one or EE one.
26+
- `RELEASE_VERSION` specifies the version of the package, for example `13.2.0-ee`.
27+
- `DOWNLOAD_URL` specifies the URL where that package can be downloaded from.
3028

3129
NOTE **Note:**
3230
We're looking at improving this situation, and using locally available packages
3331
[in issue #5550](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/5550).
3432

35-
## Building the Docker image
33+
## Build the Docker image
3634

3735
To build the Docker image after populating the `RELEASE` file:
3836

@@ -41,4 +39,4 @@ cd docker
4139
docker build -t omnibus-gitlab-image:custom .
4240
```
4341

44-
The image will be built and tagged as `omnibus-gitlab-image:custom`.
42+
The image is built and tagged as `omnibus-gitlab-image:custom`.

0 commit comments

Comments
 (0)