Commit e872be6d authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs/fix-note-lists' into 'master'

Fix note lists throughout docs

See merge request gitlab-org/gitlab-ce!26346
parents 9266901e c7fdfeea
# GitLab Container Registry administration # GitLab Container Registry administration
> **Notes:** > **Notes:**
>
> - [Introduced][ce-4040] in GitLab 8.8. > - [Introduced][ce-4040] in GitLab 8.8.
> - Container Registry manifest `v1` support was added in GitLab 8.9 to support > - Container Registry manifest `v1` support was added in GitLab 8.9 to support
> Docker versions earlier than 1.10. > Docker versions earlier than 1.10.
......
...@@ -14,6 +14,7 @@ a hosted cloud solution or you can use the one that comes bundled with ...@@ -14,6 +14,7 @@ a hosted cloud solution or you can use the one that comes bundled with
Omnibus GitLab packages. Omnibus GitLab packages.
> **Notes:** > **Notes:**
>
> - Redis requires authentication for High Availability. See > - Redis requires authentication for High Availability. See
> [Redis Security](https://redis.io/topics/security) documentation for more > [Redis Security](https://redis.io/topics/security) documentation for more
> information. We recommend using a combination of a Redis password and tight > information. We recommend using a combination of a Redis password and tight
...@@ -55,6 +56,7 @@ components below. ...@@ -55,6 +56,7 @@ components below.
### High Availability with Sentinel ### High Availability with Sentinel
> **Notes:** > **Notes:**
>
> - Starting with GitLab `8.11`, you can configure a list of Redis Sentinel > - Starting with GitLab `8.11`, you can configure a list of Redis Sentinel
> servers that will monitor a group of Redis servers to provide failover support. > servers that will monitor a group of Redis servers to provide failover support.
> - Starting with GitLab `8.14`, the Omnibus GitLab Enterprise Edition package > - Starting with GitLab `8.14`, the Omnibus GitLab Enterprise Edition package
...@@ -231,6 +233,7 @@ Pick the one that suits your needs. ...@@ -231,6 +233,7 @@ Pick the one that suits your needs.
This is the section where we install and set up the new Redis instances. This is the section where we install and set up the new Redis instances.
> **Notes:** > **Notes:**
>
> - We assume that you have installed GitLab and all HA components from scratch. If you > - We assume that you have installed GitLab and all HA components from scratch. If you
> already have it installed and running, read how to > already have it installed and running, read how to
> [switch from a single-machine installation to Redis HA](#switching-from-an-existing-single-machine-installation-to-redis-ha). > [switch from a single-machine installation to Redis HA](#switching-from-an-existing-single-machine-installation-to-redis-ha).
......
# Jobs artifacts administration # Jobs artifacts administration
> **Notes:** > **Notes:**
>
> - Introduced in GitLab 8.2 and GitLab Runner 0.7.0. > - Introduced in GitLab 8.2 and GitLab Runner 0.7.0.
> - Starting with GitLab 8.4 and GitLab Runner 1.0, the artifacts archive format changed to `ZIP`. > - Starting with GitLab 8.4 and GitLab Runner 1.0, the artifacts archive format changed to `ZIP`.
> - Starting with GitLab 8.17, builds are renamed to jobs. > - Starting with GitLab 8.17, builds are renamed to jobs.
...@@ -86,6 +87,7 @@ _The artifacts are stored by default in ...@@ -86,6 +87,7 @@ _The artifacts are stored by default in
### Using object storage ### Using object storage
> **Notes:** > **Notes:**
>
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1762) in > - [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1762) in
> [GitLab Premium](https://about.gitlab.com/pricing/) 9.4. > [GitLab Premium](https://about.gitlab.com/pricing/) 9.4.
> - Since version 9.5, artifacts are [browsable](../user/project/pipelines/job_artifacts.md#browsing-artifacts), > - Since version 9.5, artifacts are [browsable](../user/project/pipelines/job_artifacts.md#browsing-artifacts),
......
# Monitoring GitLab with Prometheus # Monitoring GitLab with Prometheus
> **Notes:** > **Notes:**
>
> - Prometheus and the various exporters listed in this page are bundled in the > - Prometheus and the various exporters listed in this page are bundled in the
> Omnibus GitLab package. Check each exporter's documentation for the timeline > Omnibus GitLab package. Check each exporter's documentation for the timeline
> they got added. For installations from source you will have to install them > they got added. For installations from source you will have to install them
......
...@@ -5,6 +5,7 @@ description: 'Learn how to administer GitLab Pages.' ...@@ -5,6 +5,7 @@ description: 'Learn how to administer GitLab Pages.'
# GitLab Pages administration # GitLab Pages administration
> **Notes:** > **Notes:**
>
> - [Introduced][ee-80] in GitLab EE 8.3. > - [Introduced][ee-80] in GitLab EE 8.3.
> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5. > - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5.
> - GitLab Pages [were ported][ce-14605] to Community Edition in GitLab 8.17. > - GitLab Pages [were ported][ce-14605] to Community Edition in GitLab 8.17.
......
# Group milestones API # Group milestones API
> **Notes:**
> [Introduced][ce-12819] in GitLab 9.5. > [Introduced][ce-12819] in GitLab 9.5.
## List group milestones ## List group milestones
......
...@@ -121,7 +121,6 @@ Parameters: ...@@ -121,7 +121,6 @@ Parameters:
## Get user agent details ## Get user agent details
> **Notes:**
> [Introduced][ce-29508] in GitLab 9.4. > [Introduced][ce-29508] in GitLab 9.4.
Available only for admins. Available only for admins.
......
...@@ -505,10 +505,9 @@ GET /projects/:id/services/jira ...@@ -505,10 +505,9 @@ GET /projects/:id/services/jira
Set JIRA service for a project. Set JIRA service for a project.
> **Notes:** > Starting with GitLab 8.14, `api_url`, `issues_url`, `new_issue_url` and
> - Starting with GitLab 8.14, `api_url`, `issues_url`, `new_issue_url` and > `project_url` are replaced by `project_key`, `url`. If you are using an
> `project_url` are replaced by `project_key`, `url`. If you are using an > older version, [follow this documentation][old-jira-api].
> older version, [follow this documentation][old-jira-api].
``` ```
PUT /projects/:id/services/jira PUT /projects/:id/services/jira
......
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
> **Notes:** > **Notes:**
> >
> * [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. > - [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.
> >
> * ChatOps is currently in alpha, with some important features missing like access control. > - ChatOps is currently in alpha, with some important features missing like access control.
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. 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.
......
...@@ -389,6 +389,7 @@ If you're running multiple Runners you will have to modify all configuration fil ...@@ -389,6 +389,7 @@ If you're running multiple Runners you will have to modify all configuration fil
## Using the GitLab Container Registry ## Using the GitLab Container Registry
> **Notes:** > **Notes:**
>
> - This feature requires GitLab 8.8 and GitLab Runner 1.2. > - This feature requires GitLab 8.8 and GitLab Runner 1.2.
> - Starting from GitLab 8.12, if you have [2FA] enabled in your account, you need > - Starting from GitLab 8.12, if you have [2FA] enabled in your account, you need
> to pass a [personal access token][pat] instead of your password in order to > to pass a [personal access token][pat] instead of your password in order to
......
...@@ -19,13 +19,14 @@ comment at any time, and anyone with [Maintainer access level][permissions] or ...@@ -19,13 +19,14 @@ comment at any time, and anyone with [Maintainer access level][permissions] or
higher can also edit a comment made by someone else. higher can also edit a comment made by someone else.
You can also reply to a comment notification email to reply to the comment if You can also reply to a comment notification email to reply to the comment if
[Reply by email] is configured for your GitLab instance. Replying to a standard comment [Reply by email] is configured for your GitLab instance. Replying to a standard comment
creates another standard comment. Replying to a discussion comment creates a reply in the creates another standard comment. Replying to a discussion comment creates a reply in the
discussion thread. Email replies support [Markdown] and [quick actions], just as if you replied from the web. discussion thread. Email replies support [Markdown] and [quick actions], just as if you replied from the web.
## Resolvable comments and discussions ## Resolvable comments and discussions
> **Notes:** > **Notes:**
>
> - The main feature was [introduced][ce-5022] in GitLab 8.11. > - The main feature was [introduced][ce-5022] in GitLab 8.11.
> - Resolvable discussions can be added only to merge request diffs. > - Resolvable discussions can be added only to merge request diffs.
...@@ -357,7 +358,7 @@ Clicking on the **Reply to comment** button will bring the reply area into focus ...@@ -357,7 +358,7 @@ Clicking on the **Reply to comment** button will bring the reply area into focus
![Reply to comment feature](img/reply_to_comment.gif) ![Reply to comment feature](img/reply_to_comment.gif)
Relying to a non-discussion comment will convert the non-discussion comment to a Relying to a non-discussion comment will convert the non-discussion comment to a
threaded discussion once the reply is submitted. This conversion is considered an edit threaded discussion once the reply is submitted. This conversion is considered an edit
to the original comment, so a note about when it was last edited will appear underneath it. to the original comment, so a note about when it was last edited will appear underneath it.
......
...@@ -63,9 +63,8 @@ together in a single list view. ...@@ -63,9 +63,8 @@ together in a single list view.
## Create a new group ## Create a new group
> **Notes:** > For a list of words that are not allowed to be used as group names see the
> - For a list of words that are not allowed to be used as group names see the > [reserved names](../reserved_names.md).
> [reserved names](../reserved_names.md).
You can create a group in GitLab from: You can create a group in GitLab from:
......
...@@ -59,6 +59,7 @@ of recovery codes. ...@@ -59,6 +59,7 @@ of recovery codes.
### Enable 2FA via U2F device ### Enable 2FA via U2F device
> **Notes:** > **Notes:**
>
> - GitLab officially only supports [Yubikey] U2F devices. > - GitLab officially only supports [Yubikey] U2F devices.
> - Support for U2F devices was added in GitLab 8.8. > - Support for U2F devices was added in GitLab 8.8.
......
# Bulk editing issues and merge requests # Bulk editing issues and merge requests
> **Notes:** > **Notes:**
>
> - A permission level of `Reporter` or higher is required in order to manage > - A permission level of `Reporter` or higher is required in order to manage
> issues. > issues.
> - A permission level of `Developer` or higher is required in order to manage > - A permission level of `Developer` or higher is required in order to manage
......
# GitLab Container Registry # GitLab Container Registry
> **Notes:** > **Notes:**
> [Introduced][ce-4040] in GitLab 8.8. >
> - [Introduced][ce-4040] in GitLab 8.8.
> - Docker Registry manifest `v1` support was added in GitLab 8.9 to support Docker > - Docker Registry manifest `v1` support was added in GitLab 8.9 to support Docker
> versions earlier than 1.10. > versions earlier than 1.10.
> - This document is about the user guide. To learn how to enable GitLab Container > - This document is about the user guide. To learn how to enable GitLab Container
...@@ -10,7 +11,7 @@ ...@@ -10,7 +11,7 @@
> - Starting from GitLab 8.12, if you have 2FA enabled in your account, you need > - Starting from GitLab 8.12, if you have 2FA enabled in your account, you need
> to pass a [personal access token][pat] instead of your password in order to > to pass a [personal access token][pat] instead of your password in order to
> login to GitLab's Container Registry. > login to GitLab's Container Registry.
> - Multiple level image names support was added in GitLab 9.1 > - Multiple level image names support was added in GitLab 9.1.
With the Docker Container Registry integrated into GitLab, every project can With the Docker Container Registry integrated into GitLab, every project can
have its own space to store its Docker images. have its own space to store its Docker images.
...@@ -41,6 +42,7 @@ to enable it. ...@@ -41,6 +42,7 @@ to enable it.
## Build and push images ## Build and push images
> **Notes:** > **Notes:**
>
> - Moving or renaming existing container registry repositories is not supported > - Moving or renaming existing container registry repositories is not supported
> once you have pushed images because the images are signed, and the > once you have pushed images because the images are signed, and the
> signature includes the repository name. > signature includes the repository name.
......
...@@ -56,6 +56,7 @@ When connecting to **JIRA Cloud**, which supports authentication via API token, ...@@ -56,6 +56,7 @@ When connecting to **JIRA Cloud**, which supports authentication via API token,
### Configuring GitLab ### Configuring GitLab
> **Notes:** > **Notes:**
>
> - The currently supported Jira versions are `v6.x` and `v7.x.`. GitLab 7.8 or > - The currently supported Jira versions are `v6.x` and `v7.x.`. GitLab 7.8 or
> higher is required. > higher is required.
> - GitLab 8.14 introduced a new way to integrate with Jira which greatly simplified > - GitLab 8.14 introduced a new way to integrate with Jira which greatly simplified
...@@ -142,6 +143,7 @@ the same goal: ...@@ -142,6 +143,7 @@ the same goal:
where `PROJECT-1` is the issue ID of the Jira project. where `PROJECT-1` is the issue ID of the Jira project.
> **Notes:** > **Notes:**
>
> - Only commits and merges into the project's default branch (usually **master**) will > - Only commits and merges into the project's default branch (usually **master**) will
> close an issue in Jira. You can change your projects default branch under > close an issue in Jira. You can change your projects default branch under
> [project settings](img/jira_project_settings.png). > [project settings](img/jira_project_settings.png).
......
# Merge requests versions # Merge requests versions
> **Notes:** > **Notes:**
>
> - [Introduced][ce-5467] in GitLab 8.12. > - [Introduced][ce-5467] in GitLab 8.12.
> - Comments are disabled while viewing outdated merge versions or comparing to > - Comments are disabled while viewing outdated merge versions or comparing to
> versions other than base. > versions other than base.
......
...@@ -205,6 +205,7 @@ With the update permission model we also extended the support for accessing ...@@ -205,6 +205,7 @@ With the update permission model we also extended the support for accessing
Container Registries for private projects. Container Registries for private projects.
> **Notes:** > **Notes:**
>
> - GitLab Runner versions prior to 1.8 don't incorporate the introduced changes > - GitLab Runner versions prior to 1.8 don't incorporate the introduced changes
> for permissions. This makes the `image:` directive to not work with private > for permissions. This makes the `image:` directive to not work with private
> projects automatically and it needs to be configured manually on Runner's host > projects automatically and it needs to be configured manually on Runner's host
......
# Exploring GitLab Pages # Exploring GitLab Pages
> **Notes:** > **Notes:**
>
> - This feature was [introduced][ee-80] in GitLab EE 8.3. > - This feature was [introduced][ee-80] in GitLab EE 8.3.
> - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5. > - Custom CNAMEs with TLS support were [introduced][ee-173] in GitLab EE 8.5.
> - GitLab Pages [was ported][ce-14605] to Community Edition in GitLab 8.17. > - GitLab Pages [was ported][ce-14605] to Community Edition in GitLab 8.17.
......
# Introduction to job artifacts # Introduction to job artifacts
> **Notes:** > **Notes:**
>
> - Since GitLab 8.2 and GitLab Runner 0.7.0, job artifacts that are created by > - Since GitLab 8.2 and GitLab Runner 0.7.0, job artifacts that are created by
> GitLab Runner are uploaded to GitLab and are downloadable as a single archive > GitLab Runner are uploaded to GitLab and are downloadable as a single archive
> (`tar.gz`) using the GitLab UI. > (`tar.gz`) using the GitLab UI.
...@@ -152,7 +153,7 @@ For example: ...@@ -152,7 +153,7 @@ For example:
https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/browse?job=coverage https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/artifacts/master/browse?job=coverage
``` ```
There is also a URL to specific files, including html files that There is also a URL to specific files, including html files that
are shown in [GitLab Pages](../../../administration/pages/index.md): are shown in [GitLab Pages](../../../administration/pages/index.md):
``` ```
...@@ -191,9 +192,9 @@ artifacts and the job's trace. ...@@ -191,9 +192,9 @@ artifacts and the job's trace.
1. Click the trash icon at the top right of the job's trace. 1. Click the trash icon at the top right of the job's trace.
1. Confirm the deletion. 1. Confirm the deletion.
## Retrieve artifacts of private projects when using GitLab CI ## Retrieve artifacts of private projects when using GitLab CI
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. 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.
[expiry date]: ../../../ci/yaml/README.md#artifactsexpire_in [expiry date]: ../../../ci/yaml/README.md#artifactsexpire_in
[ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399 [ce-14399]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14399
\ No newline at end of file
# Pipeline schedules # Pipeline schedules
> **Notes**: > **Notes**:
>
> - This feature was introduced in 9.1 as [Trigger Schedule][ce-10533]. > - This feature was introduced in 9.1 as [Trigger Schedule][ce-10533].
> - In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853]. > - In 9.2, the feature was [renamed to Pipeline Schedule][ce-10853].
> - Cron notation is parsed by [Fugit](https://github.com/floraison/fugit). > - Cron notation is parsed by [Fugit](https://github.com/floraison/fugit).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment