Skip to content

Commit c7fdfee

Browse files
ereadaxilleas
authored andcommitted
Fix note lists throughout docs
1 parent 9266901 commit c7fdfee

File tree

21 files changed

+35
-18
lines changed

21 files changed

+35
-18
lines changed

doc/administration/container_registry.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GitLab Container Registry administration
22

33
> **Notes:**
4+
>
45
> - [Introduced][ce-4040] in GitLab 8.8.
56
> - Container Registry manifest `v1` support was added in GitLab 8.9 to support
67
> Docker versions earlier than 1.10.

doc/administration/high_availability/redis.md

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ a hosted cloud solution or you can use the one that comes bundled with
1414
Omnibus GitLab packages.
1515

1616
> **Notes:**
17+
>
1718
> - Redis requires authentication for High Availability. See
1819
> [Redis Security](https://redis.io/topics/security) documentation for more
1920
> information. We recommend using a combination of a Redis password and tight
@@ -55,6 +56,7 @@ components below.
5556
### High Availability with Sentinel
5657

5758
> **Notes:**
59+
>
5860
> - Starting with GitLab `8.11`, you can configure a list of Redis Sentinel
5961
> servers that will monitor a group of Redis servers to provide failover support.
6062
> - Starting with GitLab `8.14`, the Omnibus GitLab Enterprise Edition package
@@ -231,6 +233,7 @@ Pick the one that suits your needs.
231233
This is the section where we install and set up the new Redis instances.
232234

233235
> **Notes:**
236+
>
234237
> - We assume that you have installed GitLab and all HA components from scratch. If you
235238
> already have it installed and running, read how to
236239
> [switch from a single-machine installation to Redis HA](#switching-from-an-existing-single-machine-installation-to-redis-ha).

doc/administration/job_artifacts.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Jobs artifacts administration
22

33
> **Notes:**
4+
>
45
> - Introduced in GitLab 8.2 and GitLab Runner 0.7.0.
56
> - Starting with GitLab 8.4 and GitLab Runner 1.0, the artifacts archive format changed to `ZIP`.
67
> - Starting with GitLab 8.17, builds are renamed to jobs.
@@ -86,6 +87,7 @@ _The artifacts are stored by default in
8687
### Using object storage
8788

8889
> **Notes:**
90+
>
8991
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1762) in
9092
> [GitLab Premium](https://about.gitlab.com/pricing/) 9.4.
9193
> - Since version 9.5, artifacts are [browsable](../user/project/pipelines/job_artifacts.md#browsing-artifacts),

doc/administration/monitoring/prometheus/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Monitoring GitLab with Prometheus
22

33
> **Notes:**
4+
>
45
> - Prometheus and the various exporters listed in this page are bundled in the
56
> Omnibus GitLab package. Check each exporter's documentation for the timeline
67
> they got added. For installations from source you will have to install them

doc/administration/pages/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: 'Learn how to administer GitLab Pages.'
55
# GitLab Pages administration
66

77
> **Notes:**
8+
>
89
> - [Introduced][ee-80] in GitLab EE 8.3.
910
> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5.
1011
> - GitLab Pages [were ported][ce-14605] to Community Edition in GitLab 8.17.

doc/api/group_milestones.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Group milestones API
22

3-
> **Notes:**
43
> [Introduced][ce-12819] in GitLab 9.5.
54
65
## List group milestones

doc/api/project_snippets.md

-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,6 @@ Parameters:
121121

122122
## Get user agent details
123123

124-
> **Notes:**
125124
> [Introduced][ce-29508] in GitLab 9.4.
126125
127126
Available only for admins.

doc/api/services.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -505,10 +505,9 @@ GET /projects/:id/services/jira
505505

506506
Set JIRA service for a project.
507507

508-
> **Notes:**
509-
> - Starting with GitLab 8.14, `api_url`, `issues_url`, `new_issue_url` and
510-
> `project_url` are replaced by `project_key`, `url`. If you are using an
511-
> older version, [follow this documentation][old-jira-api].
508+
> Starting with GitLab 8.14, `api_url`, `issues_url`, `new_issue_url` and
509+
> `project_url` are replaced by `project_key`, `url`. If you are using an
510+
> older version, [follow this documentation][old-jira-api].
512511
513512
```
514513
PUT /projects/:id/services/jira

doc/ci/chatops/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
> **Notes:**
44
>
5-
> * [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/4466) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6. [Moved](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24780) to [GitLab Core](https://about.gitlab.com/pricing/) in 11.9.
5+
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/4466) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6. [Moved](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/24780) to [GitLab Core](https://about.gitlab.com/pricing/) in 11.9.
66
>
7-
> * ChatOps is currently in alpha, with some important features missing like access control.
7+
> - ChatOps is currently in alpha, with some important features missing like access control.
88
99
GitLab ChatOps provides a method to interact with CI/CD jobs through chat services like Slack. Many organizations' discussion, collaboration, and troubleshooting is taking place in chat services these days, and having a method to run CI/CD jobs with output posted back to the channel can significantly augment a team's workflow.
1010

doc/ci/docker/using_docker_build.md

+1
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,7 @@ If you're running multiple Runners you will have to modify all configuration fil
389389
## Using the GitLab Container Registry
390390
391391
> **Notes:**
392+
>
392393
> - This feature requires GitLab 8.8 and GitLab Runner 1.2.
393394
> - Starting from GitLab 8.12, if you have [2FA] enabled in your account, you need
394395
> to pass a [personal access token][pat] instead of your password in order to

doc/user/discussions/index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ comment at any time, and anyone with [Maintainer access level][permissions] or
1919
higher can also edit a comment made by someone else.
2020

2121
You can also reply to a comment notification email to reply to the comment if
22-
[Reply by email] is configured for your GitLab instance. Replying to a standard comment
22+
[Reply by email] is configured for your GitLab instance. Replying to a standard comment
2323
creates another standard comment. Replying to a discussion comment creates a reply in the
2424
discussion thread. Email replies support [Markdown] and [quick actions], just as if you replied from the web.
2525

2626
## Resolvable comments and discussions
2727

2828
> **Notes:**
29+
>
2930
> - The main feature was [introduced][ce-5022] in GitLab 8.11.
3031
> - Resolvable discussions can be added only to merge request diffs.
3132
@@ -357,7 +358,7 @@ Clicking on the **Reply to comment** button will bring the reply area into focus
357358

358359
![Reply to comment feature](img/reply_to_comment.gif)
359360

360-
Relying to a non-discussion comment will convert the non-discussion comment to a
361+
Relying to a non-discussion comment will convert the non-discussion comment to a
361362
threaded discussion once the reply is submitted. This conversion is considered an edit
362363
to the original comment, so a note about when it was last edited will appear underneath it.
363364

doc/user/group/index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,8 @@ together in a single list view.
6363

6464
## Create a new group
6565

66-
> **Notes:**
67-
> - For a list of words that are not allowed to be used as group names see the
68-
> [reserved names](../reserved_names.md).
66+
> For a list of words that are not allowed to be used as group names see the
67+
> [reserved names](../reserved_names.md).
6968
7069
You can create a group in GitLab from:
7170

doc/user/profile/account/two_factor_authentication.md

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ of recovery codes.
5959
### Enable 2FA via U2F device
6060

6161
> **Notes:**
62+
>
6263
> - GitLab officially only supports [Yubikey] U2F devices.
6364
> - Support for U2F devices was added in GitLab 8.8.
6465

doc/user/project/bulk_editing.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Bulk editing issues and merge requests
22

33
> **Notes:**
4+
>
45
> - A permission level of `Reporter` or higher is required in order to manage
56
> issues.
67
> - A permission level of `Developer` or higher is required in order to manage

doc/user/project/container_registry.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# GitLab Container Registry
22

33
> **Notes:**
4-
> [Introduced][ce-4040] in GitLab 8.8.
4+
>
5+
> - [Introduced][ce-4040] in GitLab 8.8.
56
> - Docker Registry manifest `v1` support was added in GitLab 8.9 to support Docker
67
> versions earlier than 1.10.
78
> - This document is about the user guide. To learn how to enable GitLab Container
@@ -10,7 +11,7 @@
1011
> - Starting from GitLab 8.12, if you have 2FA enabled in your account, you need
1112
> to pass a [personal access token][pat] instead of your password in order to
1213
> login to GitLab's Container Registry.
13-
> - Multiple level image names support was added in GitLab 9.1
14+
> - Multiple level image names support was added in GitLab 9.1.
1415
1516
With the Docker Container Registry integrated into GitLab, every project can
1617
have its own space to store its Docker images.
@@ -41,6 +42,7 @@ to enable it.
4142
## Build and push images
4243

4344
> **Notes:**
45+
>
4446
> - Moving or renaming existing container registry repositories is not supported
4547
> once you have pushed images because the images are signed, and the
4648
> signature includes the repository name.

doc/user/project/integrations/jira.md

+2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ When connecting to **JIRA Cloud**, which supports authentication via API token,
5656
### Configuring GitLab
5757

5858
> **Notes:**
59+
>
5960
> - The currently supported Jira versions are `v6.x` and `v7.x.`. GitLab 7.8 or
6061
> higher is required.
6162
> - GitLab 8.14 introduced a new way to integrate with Jira which greatly simplified
@@ -142,6 +143,7 @@ the same goal:
142143
where `PROJECT-1` is the issue ID of the Jira project.
143144

144145
> **Notes:**
146+
>
145147
> - Only commits and merges into the project's default branch (usually **master**) will
146148
> close an issue in Jira. You can change your projects default branch under
147149
> [project settings](img/jira_project_settings.png).

doc/user/project/merge_requests/versions.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Merge requests versions
22

33
> **Notes:**
4+
>
45
> - [Introduced][ce-5467] in GitLab 8.12.
56
> - Comments are disabled while viewing outdated merge versions or comparing to
67
> versions other than base.

doc/user/project/new_ci_build_permissions_model.md

+1
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ With the update permission model we also extended the support for accessing
205205
Container Registries for private projects.
206206

207207
> **Notes:**
208+
>
208209
> - GitLab Runner versions prior to 1.8 don't incorporate the introduced changes
209210
> for permissions. This makes the `image:` directive to not work with private
210211
> projects automatically and it needs to be configured manually on Runner's host

doc/user/project/pages/introduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Exploring GitLab Pages
22

33
> **Notes:**
4+
>
45
> - This feature was [introduced][ee-80] in GitLab EE 8.3.
56
> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5.
67
> - GitLab Pages [was ported][ce-14605] to Community Edition in GitLab 8.17.

doc/user/project/pipelines/job_artifacts.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Introduction to job artifacts
22

33
> **Notes:**
4+
>
45
> - Since GitLab 8.2 and GitLab Runner 0.7.0, job artifacts that are created by
56
> GitLab Runner are uploaded to GitLab and are downloadable as a single archive
67
> (`tar.gz`) using the GitLab UI.
@@ -152,7 +153,7 @@ For example:
152153
https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/browse?job=coverage
153154
```
154155

155-
There is also a URL to specific files, including html files that
156+
There is also a URL to specific files, including html files that
156157
are shown in [GitLab Pages](../../../administration/pages/index.md):
157158

158159
```
@@ -191,9 +192,9 @@ artifacts and the job's trace.
191192
1. Click the trash icon at the top right of the job's trace.
192193
1. Confirm the deletion.
193194

194-
## Retrieve artifacts of private projects when using GitLab CI
195+
## Retrieve artifacts of private projects when using GitLab CI
195196

196197
In order to retrieve a job artifact of a different project, you might need to use a private token in order to [authenticate and download](../../../api/jobs.md#get-job-artifacts) the artifacts.
197198

198199
[expiry date]: ../../../ci/yaml/README.md#artifactsexpire_in
199-
[ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399
200+
[ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399

doc/user/project/pipelines/schedules.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Pipeline schedules
22

33
> **Notes**:
4+
>
45
> - This feature was introduced in 9.1 as [Trigger Schedule][ce-10533].
56
> - In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853].
67
> - Cron notation is parsed by [Fugit](https://github.com/floraison/fugit).

0 commit comments

Comments
 (0)