Skip to content

Commit a3d85d4

Browse files
committed
Clear some Vale warnings related to product terminology
1 parent 3e95b90 commit a3d85d4

File tree

11 files changed

+73
-61
lines changed

11 files changed

+73
-61
lines changed

Diff for: doc/_index.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,4 @@ to work best with the available resources. Check out the [documentation](setting
8888

8989
## Troubleshooting
9090

91-
For troubleshooting details, see [Troubleshooting Omnibus GitLab installation issues](troubleshooting.md).
92-
93-
## Omnibus GitLab developer documentation
94-
95-
See the [development documentation](development/_index.md)
91+
For troubleshooting details, see [Troubleshooting Linux package installation](troubleshooting.md).

Diff for: doc/build/_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,15 @@ for more details.
1515

1616
## `omnibus-gitlab` packages
1717

18+
<!-- vale gitlab_base.SubstitutionWarning = NO -->
19+
1820
`omnibus-gitlab` uses [Omnibus](https://github.com/chef/omnibus) for
1921
building packages for the supported operating systems. Omnibus detects
2022
the OS where it is being used and build packages for that OS. You should use a
2123
Docker container corresponding to the OS as the environment for building packages.
2224

25+
<!-- vale gitlab_base.SubstitutionWarning = YES -->
26+
2327
How to build a custom package locally is described in the
2428
[dedicated document](build_package.md).
2529

Diff for: doc/build/build_package.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ project's [Container Registry](https://gitlab.com/gitlab-org/gitlab-omnibus-buil
2727
docker pull registry.gitlab.com/gitlab-org/gitlab-omnibus-builder/debian_10:${BUILDER_IMAGE_REVISION}
2828
```
2929

30-
1. Clone the Omnibus GitLab source and change to the cloned directory:
30+
1. Clone the `omnibus-gitlab` source and change to the cloned directory:
3131

3232
```shell
3333
git clone https://gitlab.com/gitlab-org/omnibus-gitlab.git ~/omnibus-gitlab
@@ -167,6 +167,8 @@ the package cache directory (`/var/cache/omnibus/pkg`):
167167
bin/omnibus clean --purge gitlab
168168
```
169169

170+
<!-- vale gitlab_base.SubstitutionWarning = NO -->
171+
170172
## Get help on Omnibus
171173

172174
For help with the Omnibus command-line interface, run the
@@ -175,3 +177,5 @@ For help with the Omnibus command-line interface, run the
175177
```shell
176178
bin/omnibus help
177179
```
180+
181+
<!-- vale gitlab_base.SubstitutionWarning = YES -->

Diff for: doc/build/team_member_docs.md

+4
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,15 @@ of manually running new pipelines.
102102

103103
## Use a specific mirror or fork of a GitLab component
104104

105+
<!-- vale gitlab_base.SubstitutionWarning = NO -->
106+
105107
The repository sources for most software that Omnibus builds are in
106108
the `.custom_sources.yml` file in the `omnibus-gitlab` repository. You can override
107109
the main GitLab components using environment variables. Check the table
108110
below for details:
109111

112+
<!-- vale gitlab_base.SubstitutionWarning = YES -->
113+
110114
| Environment variable | Description |
111115
| --------------------------------------------- | ----------- |
112116
| `ALTERNATIVE_PRIVATE_TOKEN` | An access token used if needing to pull from private repositories. |

Diff for: doc/jihu_edition.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Additionally, you can navigate to the GitLab administration panel of your server
5353

5454
## Update GitLab Enterprise Edition to JiHu Edition
5555

56-
To update an existing GitLab Enterprise Edition (EE) server installed using the Omnibus GitLab
56+
To update an existing GitLab Enterprise Edition (EE) server installed using the Linux
5757
packages to GitLab JiHu Edition (JH), you install the JiHu Edition (JH)
5858
package on top of EE.
5959

Diff for: doc/maintenance/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ See [settings/logs.md.](../settings/logs.md)
7373

7474
## Starting and stopping
7575

76-
After Omnibus GitLab is installed and configured, your server has a runit
76+
After the Linux package is installed and configured, your server has a runit
7777
service directory (`runsvdir`) process running that gets started at boot via
7878
`/etc/inittab` or the `/etc/init/gitlab-runsvdir.conf` Upstart resource. You
7979
should not have to deal with the `runsvdir` process directly; you can use the
@@ -161,7 +161,7 @@ sudo gitlab-psql -d gitlabhq_production
161161

162162
This will only work after you have run `gitlab-ctl reconfigure` at
163163
least once. The `gitlab-psql` command cannot be used to connect to a
164-
remote PostgreSQL server, nor to connect to a local non-Omnibus PostgreSQL
164+
remote PostgreSQL server, nor to connect to a local non-Linux package PostgreSQL
165165
server.
166166

167167
### Starting a PostgreSQL superuser `psql` session in Geo tracking database

Diff for: doc/release/_index.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
55
title: Omnibus GitLab release process
66
---
77

8-
Our main goal is to make it clear which version of GitLab is in an omnibus
8+
Our main goal is to make it clear which version of GitLab is in a Linux
99
package.
1010

11-
## How is the official Omnibus GitLab package built
11+
## How is the official Linux package built
1212

1313
The official package build is fully automated by GitLab Inc.
1414

@@ -26,16 +26,16 @@ built on CentOS6 servers, Debian 8 packages on Debian 8 servers and so on).
2626
The number of build servers varies but there is always at least one build
2727
server per platform.
2828

29-
The Omnibus GitLab project fully utilizes GitLab CI. This means that each push
30-
to the Omnibus GitLab repository will trigger a build in GitLab CI which will
29+
The `omnibus-gitlab` project fully utilizes GitLab CI. This means that each push
30+
to the `omnibus-gitlab` repository will trigger a build in GitLab CI which will
3131
then create a package.
3232

33-
Since we deploy GitLab.com using Omnibus GitLab packages, we need a separate
33+
Since we deploy GitLab.com using Linux packages, we need a separate
3434
remote to build the packages in case of a problem with GitLab.com or due to
3535
a security release of a package.
3636

3737
This remote is located on `https://dev.gitlab.org`. The only difference between the
38-
Omnibus GitLab project on `https://dev.gitlab.org` and other public remotes is that the
38+
`omnibus-gitlab` project on `https://dev.gitlab.org` and other public remotes is that the
3939
project has active GitLab CI and has specific runners assigned to the project
4040
which run on the build servers. This is also the case for all GitLab components,
4141
eg. GitLab Shell is exactly the same on `https://dev.gitlab.org` as it is on GitLab.com.
@@ -49,22 +49,22 @@ Amazon S3 bucket which stores the test packages.
4949

5050
GitLab Inc is using the [release-tools project](https://gitlab.com/gitlab-org/release-tools/tree/master) to automate the release tasks
5151
for every release. When the release manager starts the release process, a couple
52-
of important things for Omnibus GitLab will be done:
52+
of important things will be done:
5353

5454
1. All remotes of the project will be synced.
5555
1. The versions of components will be read from GitLab CE/EE repository
56-
(eg. `VERSION`, `GITLAB_SHELL_VERSION`) and written to the Omnibus GitLab repository.
57-
1. A specific Git tag will be created and synced to Omnibus GitLab repositories.
56+
(eg. `VERSION`, `GITLAB_SHELL_VERSION`) and written to the `omnibus-gitlab` repository.
57+
1. A specific Git tag will be created and synced to `omnibus-gitlab` repositories.
5858

59-
When the Omnibus GitLab repository on `https://dev.gitlab.org` gets updated, GitLab CI
59+
When the `omnibus-gitlab` repository on `https://dev.gitlab.org` gets updated, GitLab CI
6060
build gets triggered.
6161

62-
The specific steps can be seen in the `.gitlab-ci.yml` file in the Omnibus GitLab
62+
The specific steps can be seen in the `.gitlab-ci.yml` file in the `omnibus-gitlab`
6363
repository. The builds are executed on all platforms at the same time.
6464

65-
During the build, Omnibus GitLab will pull external libraries from their source
65+
During the build, `omnibus-gitlab` pulls external libraries from their source
6666
locations and GitLab components like GitLab, GitLab Shell, GitLab Workhorse, and
67-
so on will be pulled from `https://dev.gitlab.org`.
67+
so on are pulled from `https://dev.gitlab.org`.
6868

6969
Once the build completes and the .deb or .rpm packages are built, depending on
7070
the build type package will be pushed to <https://packages.gitlab.com> or to a temporary
@@ -75,7 +75,7 @@ the build type package will be pushed to <https://packages.gitlab.com> or to a t
7575
### On your development machine
7676

7777
1. Pick a tag of GitLab to package (e.g. `v6.6.0`).
78-
1. Create a release branch in your Omnibus GitLab repo (e.g. `6-6-stable`).
78+
1. Create a release branch in your `omnibus-gitlab` repo (e.g. `6-6-stable`).
7979
1. If the release branch already exists, for instance because you are doing a
8080
patch release, make sure to pull the latest changes to your local machine:
8181

@@ -105,8 +105,8 @@ the build type package will be pushed to <https://packages.gitlab.com> or to a t
105105
git commit
106106
```
107107

108-
1. Create an annotated tag in Omnibus GitLab corresponding to the GitLab tag.
109-
The omnibus tag looks like: `MAJOR.MINOR.PATCH+OTHER.OMNIBUS_RELEASE`, where
108+
1. Create an annotated tag in `omnibus-gitlab` corresponding to the GitLab tag.
109+
The `omnibus-gitlab` tag looks like: `MAJOR.MINOR.PATCH+OTHER.OMNIBUS_RELEASE`, where
110110
`MAJOR.MINOR.PATCH` is the GitLab version, `OTHER` can be something like `ce`,
111111
`ee` or `rc1` (or `rc1.ee`), and `OMNIBUS_RELEASE` is a number (starting at 0):
112112

@@ -116,13 +116,13 @@ the build type package will be pushed to <https://packages.gitlab.com> or to a t
116116

117117
{{< alert type="warning" >}}
118118

119-
Do NOT use a hyphen `-` anywhere in the Omnibus GitLab tag.
119+
Do NOT use a hyphen `-` anywhere in the `omnibus-gitlab` tag.
120120

121121
{{< /alert >}}
122122

123-
Examples of converting an upstream tag to an omnibus tag sequence:
123+
Examples of converting an upstream tag to an `omnibus-gitlab` tag sequence:
124124

125-
| upstream tag | omnibus tag sequence |
125+
| upstream tag | `omnibus-gitlab` tag sequence |
126126
| ------------ | -------------------- |
127127
| `v7.10.4` | `7.10.4+ce.0`, `7.10.4+ce.1`, `...` |
128128
| `v7.10.4-ee` | `7.10.4+ee.0`, `7.10.4+ee.1`, `...` |

Diff for: doc/roles/_index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
stage: Systems
33
group: Distribution
44
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
5-
title: Omnibus GitLab High Availability Roles
5+
title: High availability roles
66
---
77

88
{{< details >}}
@@ -12,9 +12,9 @@ title: Omnibus GitLab High Availability Roles
1212

1313
{{< /details >}}
1414

15-
Omnibus GitLab includes various software components/services to support running GitLab in
15+
Linux packages include various software components/services to support running GitLab in
1616
a high availability configuration. By default, some of these supporting services
17-
are disabled, and Omnibus GitLab is configured to run as a single node installation.
17+
are disabled, and GitLab is configured to run as a single node installation.
1818
Each service can be enabled or disabled using configuration settings in `/etc/gitlab/gitlab.rb`,
1919
but the introduction of `roles` allows you to easily enable a group of services,
2020
and provides better default configuration based on the high availability roles you
@@ -48,7 +48,7 @@ roles ['geo_primary_role']
4848

4949
The majority of the following roles will only work on a
5050
[GitLab Enterprise Edition](https://about.gitlab.com/install/ce-or-ee/), meaning
51-
a `gitlab-ee` Omnibus package. It will be mentioned next to each role.
51+
a `gitlab-ee` Linux package. It will be mentioned next to each role.
5252

5353
### GitLab App Role
5454

Diff for: doc/settings/configuration.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ git_data_dirs({
179179
```
180180

181181
you'll need to redefine the configuration under `gitaly['configuration']` instead.
182-
Note that the `/repositories` suffix must be appended to the path, as it was previously
183-
appended by Omnibus internally.
182+
Note that the `/repositories` suffix must be appended to the path because it was previously
183+
appended internally.
184184

185185
```ruby
186186
gitaly['configuration'] = {
@@ -193,11 +193,15 @@ gitaly['configuration'] = {
193193
}
194194
```
195195

196+
<!-- vale gitlab_base.SubstitutionWarning = NO -->
197+
196198
It's important to note that the parent directory of the `path` must also be managed by
197-
Omnibus. Following the example above, Omnibus will need to modify the permissions of
199+
Omnibus. Following the example above, Omnibus must modify the permissions of
198200
`/mnt/nas/git-data` on reconfiguration and may store data in that directory during
199201
runtime. You should select an appropriate `path` that allows for this behavior.
200202

203+
<!-- vale gitlab_base.SubstitutionWarning = YES -->
204+
201205
## Store Git data in an alternative directory
202206

203207
By default, Linux package installations store the Git repository data under

Diff for: doc/settings/database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ To opt out of automatic PostgreSQL upgrades during GitLab package upgrades, run:
584584
sudo touch /etc/gitlab/disable-postgresql-upgrade
585585
```
586586

587-
If you use the Omnibus Docker image, you can disable automatic upgrades by
587+
If you use the Docker image, you can disable automatic upgrades by
588588
setting the `GITLAB_SKIP_PG_UPGRADE` environment variable to `true`.
589589

590590
### Revert packaged PostgreSQL server to the previous version

0 commit comments

Comments
 (0)