Skip to content

G
gitlab-ce
Commit 73c6477b authored by Marcel Amirault's avatar Marcel Amirault Committed by Achilleas Pipinellis
Browse files
Options

Changing badges to use parentheses not brackets 

Previously, we used brackets to denote the tier badges,
but this made Kramdown, the docs site Markdown renderer,
show many warnings when building the site. This is now
fixed by using parentheses instead of square brackets.

This was caused by [PREMIUM] looking like a link to
Kramdown, which couldn't find a URL there.

See:
- https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484
- https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
parent 902525ab
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 647 additions and 647 deletions
doc/README.md
View file @ 73c6477b
This diff is collapsed.
doc/administration/audit_events.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
last_updated: 2019-02-04
---
# Audit Events **[STARTER]**
# Audit Events **(STARTER)**
GitLab offers a way to view the changes made within the GitLab server for owners and administrators on a [paid plan][ee].
......@@ -32,7 +32,7 @@ There are two kinds of events logged:
- Instance events scoped to the whole GitLab instance, used by your Compliance team to
perform formal audits.
### Group events **[STARTER]**
### Group events **(STARTER)**
NOTE: **Note:**
You need Owner [permissions] to view the group Audit Events page.
......@@ -59,7 +59,7 @@ From there, you can see the following actions:
- 2FA enforcement/grace period changed
- Roles allowed to create project changed
### Project events **[STARTER]**
### Project events **(STARTER)**
NOTE: **Note:**
You need Maintainer [permissions] or higher to view the project Audit Events page.
......@@ -74,7 +74,7 @@ From there, you can see the following actions:
- Permission changes of a user assigned to a project
- User was removed from project
### Instance events **[PREMIUM ONLY]**
### Instance events **(PREMIUM ONLY)**
> [Introduced][ee-2336] in [GitLab Premium][ee] 9.3.
......
doc/administration/auditor_users.md
View file @ 73c6477b
# Auditor users **[PREMIUM ONLY]**
# Auditor users **(PREMIUM ONLY)**
>[Introduced][ee-998] in [GitLab Premium][eep] 8.17.
......
doc/administration/auth/README.md
View file @ 73c6477b
......@@ -9,11 +9,11 @@ providers.
- [LDAP](ldap.md) Includes Active Directory, Apple Open Directory, Open LDAP,
and 389 Server
- [LDAP for GitLab EE](ldap-ee.md): LDAP additions to GitLab Enterprise Editions **[STARTER ONLY]**
- [LDAP for GitLab EE](ldap-ee.md): LDAP additions to GitLab Enterprise Editions **(STARTER ONLY)**
- [OmniAuth](../../integration/omniauth.md) Sign in via Twitter, GitHub, GitLab.com, Google,
Bitbucket, Facebook, Shibboleth, Crowd, Azure, Authentiq ID, and JWT
- [CAS](../../integration/cas.md) Configure GitLab to sign in using CAS
- [SAML](../../integration/saml.md) Configure GitLab as a SAML 2.0 Service Provider
- [Okta](okta.md) Configure GitLab to sign in using Okta
- [Authentiq](authentiq.md): Enable the Authentiq OmniAuth provider for passwordless authentication
- [Smartcard](smartcard.md) Smartcard authentication **[PREMIUM ONLY]**
- [Smartcard](smartcard.md) Smartcard authentication **(PREMIUM ONLY)**
doc/administration/auth/google_secure_ldap.md
View file @ 73c6477b
# Google Secure LDAP **[CORE ONLY]**
# Google Secure LDAP **(CORE ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/46391) in GitLab 11.9.
......
doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md
View file @ 73c6477b
......@@ -111,7 +111,7 @@ The initial configuration of LDAP in GitLab requires changes to the `gitlab.rb`
The two Active Directory specific values are `active_directory: true` and `uid: 'sAMAccountName'`. `sAMAccountName` is an attribute returned by Active Directory used for GitLab usernames. See the example output from `ldapsearch` for a full list of attributes a "person" object (user) has in **AD** - [`ldapsearch` example](#using-ldapsearch-unix)
> Both group_base and admin_group configuration options are only available in GitLab Enterprise Edition. See [GitLab EE - LDAP Features](../how_to_configure_ldap_gitlab_ee/index.html#gitlab-enterprise-edition---ldap-features) **[STARTER ONLY]**
> Both group_base and admin_group configuration options are only available in GitLab Enterprise Edition. See [GitLab EE - LDAP Features](../how_to_configure_ldap_gitlab_ee/index.html#gitlab-enterprise-edition---ldap-features) **(STARTER ONLY)**
### Example `gitlab.rb` LDAP
......@@ -267,4 +267,4 @@ have extended functionalities with LDAP, such as:
- Updating user permissions
- Multiple LDAP servers
Read through the article on [LDAP for GitLab EE](../how_to_configure_ldap_gitlab_ee/index.md) **[STARTER ONLY]** for an overview.
Read through the article on [LDAP for GitLab EE](../how_to_configure_ldap_gitlab_ee/index.md) **(STARTER ONLY)** for an overview.
doc/administration/auth/how_to_configure_ldap_gitlab_ee/index.md
View file @ 73c6477b
......@@ -6,7 +6,7 @@ article_type: admin guide
date: 2017-05-03
---
# How to configure LDAP with GitLab EE **[STARTER ONLY]**
# How to configure LDAP with GitLab EE **(STARTER ONLY)**
## Introduction
......
doc/administration/auth/ldap-ee.md
View file @ 73c6477b
# LDAP Additions in GitLab EE **[STARTER ONLY]**
# LDAP Additions in GitLab EE **(STARTER ONLY)**
This is a continuation of the main [LDAP documentation](ldap.md), detailing LDAP
features specific to GitLab Enterprise Edition Starter, Premium and Ultimate.
......
doc/administration/auth/ldap.md
View file @ 73c6477b
......@@ -12,7 +12,7 @@ including group membership syncing as well as multiple LDAP servers support.
The information on this page is relevant for both GitLab CE and EE. For more
details about EE-specific LDAP features, see the
[LDAP Enterprise Edition documentation](ldap-ee.md). **[STARTER ONLY]**
[LDAP Enterprise Edition documentation](ldap-ee.md). **(STARTER ONLY)**
## Security
......@@ -46,7 +46,7 @@ LDAP-enabled users can always authenticate with Git using their GitLab username
or email and LDAP password, even if password authentication for Git is disabled
in the application settings.
## Google Secure LDAP **[CORE ONLY]**
## Google Secure LDAP **(CORE ONLY)**
> Introduced in GitLab 11.9.
......@@ -62,7 +62,7 @@ to connect to one GitLab server.
For a complete guide on configuring LDAP with GitLab Community Edition, please check
the admin guide [How to configure LDAP with GitLab CE](how_to_configure_ldap_gitlab_ce/index.md).
For GitLab Enterprise Editions, see also [How to configure LDAP with GitLab EE](how_to_configure_ldap_gitlab_ee/index.md). **[STARTER ONLY]**
For GitLab Enterprise Editions, see also [How to configure LDAP with GitLab EE](how_to_configure_ldap_gitlab_ee/index.md). **(STARTER ONLY)**
To enable LDAP integration you need to add your LDAP server settings in
`/etc/gitlab/gitlab.rb` or `/home/git/gitlab/config/gitlab.yml` for Omnibus
......@@ -387,7 +387,7 @@ group, you can use the following syntax:
Find more information about this "LDAP_MATCHING_RULE_IN_CHAIN" filter at
<https://docs.microsoft.com/en-us/windows/desktop/ADSI/search-filter-syntax>. Support for
nested members in the user filter should not be confused with
[group sync nested groups support](ldap-ee.md#supported-ldap-group-typesattributes). **[STARTER ONLY]**
[group sync nested groups support](ldap-ee.md#supported-ldap-group-typesattributes). **(STARTER ONLY)**
Please note that GitLab does not support the custom filter syntax used by
omniauth-ldap.
......
doc/administration/auth/smartcard.md
View file @ 73c6477b
# Smartcard authentication **[PREMIUM ONLY]**
# Smartcard authentication **(PREMIUM ONLY)**
GitLab supports authentication using smartcards.
......
doc/administration/database_load_balancing.md
View file @ 73c6477b
# Database Load Balancing **[PREMIUM ONLY]**
# Database Load Balancing **(PREMIUM ONLY)**
> [Introduced][ee-1283] in [GitLab Premium][eep] 9.0.
......
doc/administration/dependency_proxy.md
View file @ 73c6477b
# GitLab Dependency Proxy administration **[PREMIUM ONLY]**
# GitLab Dependency Proxy administration **(PREMIUM ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/7934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.11.
......
doc/administration/geo/disaster_recovery/background_verification.md
View file @ 73c6477b
# Automatic background verification **[PREMIUM ONLY]**
# Automatic background verification **(PREMIUM ONLY)**
NOTE: **Note:**
Automatic background verification of repositories and wikis was added in
......
doc/administration/geo/disaster_recovery/bring_primary_back.md
View file @ 73c6477b
# Bring a demoted primary node back online **[PREMIUM ONLY]**
# Bring a demoted primary node back online **(PREMIUM ONLY)**
After a failover, it is possible to fail back to the demoted **primary** node to
restore your original configuration. This process consists of two steps:
......
doc/administration/geo/disaster_recovery/index.md
View file @ 73c6477b
# Disaster Recovery **[PREMIUM ONLY]**
# Disaster Recovery **(PREMIUM ONLY)**
Geo replicates your database, your Git repositories, and few other assets.
We will support and replicate more data in the future, that will enable you to
......
doc/administration/geo/disaster_recovery/planned_failover.md
View file @ 73c6477b
# Disaster recovery for planned failover **[PREMIUM ONLY]**
# Disaster recovery for planned failover **(PREMIUM ONLY)**
The primary use-case of Disaster Recovery is to ensure business continuity in
the event of unplanned outage, but it can be used in conjunction with a planned
......
doc/administration/geo/replication/configuration.md
View file @ 73c6477b
# Geo configuration **[PREMIUM ONLY]**
# Geo configuration **(PREMIUM ONLY)**
## Configuring a new **secondary** node
......
doc/administration/geo/replication/database.md
View file @ 73c6477b
# Geo database replication **[PREMIUM ONLY]**
# Geo database replication **(PREMIUM ONLY)**
NOTE: **Note:**
The following steps are for Omnibus installs only. Using Geo with source-based installs was **deprecated** in GitLab 11.5.
......
doc/administration/geo/replication/docker_registry.md
View file @ 73c6477b
# Docker Registry for a secondary node **[PREMIUM ONLY]**
# Docker Registry for a secondary node **(PREMIUM ONLY)**
You can set up a [Docker Registry] on your
**secondary** Geo node that mirrors the one on the **primary** Geo node.
......
doc/administration/geo/replication/external_database.md
View file @ 73c6477b
# Geo with external PostgreSQL instances **[PREMIUM ONLY]**
# Geo with external PostgreSQL instances **(PREMIUM ONLY)**
This document is relevant if you are using a PostgreSQL instance that is *not
managed by Omnibus*. This includes cloud-managed instances like AWS RDS, or
......
doc/administration/geo/replication/faq.md
View file @ 73c6477b
# Geo Frequently Asked Questions **[PREMIUM ONLY]**
# Geo Frequently Asked Questions **(PREMIUM ONLY)**
## What are the minimum requirements to run Geo?
......
doc/administration/geo/replication/high_availability.md
View file @ 73c6477b
# Geo High Availability **[PREMIUM ONLY]**
# Geo High Availability **(PREMIUM ONLY)**
This document describes a minimal reference architecture for running Geo
in a high availability configuration. If your HA setup differs from the one
......
doc/administration/geo/replication/index.md
View file @ 73c6477b
# Geo Replication **[PREMIUM ONLY]**
# Geo Replication **(PREMIUM ONLY)**
Geo is the solution for widely distributed development teams.
......
doc/administration/geo/replication/object_storage.md
View file @ 73c6477b
# Geo with Object storage **[PREMIUM ONLY]**
# Geo with Object storage **(PREMIUM ONLY)**
Geo can be used in combination with Object Storage (AWS S3, or
other compatible object storage).
......
doc/administration/geo/replication/remove_geo_node.md
View file @ 73c6477b
# Removing secondary Geo nodes **[PREMIUM ONLY]**
# Removing secondary Geo nodes **(PREMIUM ONLY)**
**Secondary** nodes can be removed from the Geo cluster using the Geo admin page of the **primary** node. To remove a **secondary** node:
......
doc/administration/geo/replication/security_review.md
View file @ 73c6477b
# Geo security review (Q&A) **[PREMIUM ONLY]**
# Geo security review (Q&A) **(PREMIUM ONLY)**
The following security review of the Geo feature set focuses on security
aspects of the feature as they apply to customers running their own GitLab
......
doc/administration/geo/replication/troubleshooting.md
View file @ 73c6477b
# Geo Troubleshooting **[PREMIUM ONLY]**
# Geo Troubleshooting **(PREMIUM ONLY)**
Setting up Geo requires careful attention to details and sometimes it's easy to
miss a step.
......
doc/administration/geo/replication/tuning.md
View file @ 73c6477b
# Tuning Geo **[PREMIUM ONLY]**
# Tuning Geo **(PREMIUM ONLY)**
## Changing the sync capacity values
......
doc/administration/geo/replication/updating_the_geo_nodes.md
View file @ 73c6477b
# Updating the Geo nodes **[PREMIUM ONLY]**
# Updating the Geo nodes **(PREMIUM ONLY)**
Depending on which version of Geo you are updating to/from, there may be
different steps.
......
doc/administration/geo/replication/using_a_geo_server.md
View file @ 73c6477b
[//]: # (Please update EE::GitLab::GeoGitAccess::GEO_SERVER_DOCS_URL if this file is moved)
# Using a Geo Server **[PREMIUM ONLY]**
# Using a Geo Server **(PREMIUM ONLY)**
After you set up the [database replication and configure the Geo nodes][req], use your closest GitLab node as you would a normal standalone GitLab instance.
......
doc/administration/high_availability/consul.md
View file @ 73c6477b
# Working with the bundled Consul service **[PREMIUM ONLY]**
# Working with the bundled Consul service **(PREMIUM ONLY)**
## Overview
......
doc/administration/high_availability/database.md
View file @ 73c6477b
# Configuring PostgreSQL for Scaling and High Availability
## Provide your own PostgreSQL instance **[CORE ONLY]**
## Provide your own PostgreSQL instance **(CORE ONLY)**
If you're hosting GitLab on a cloud provider, you can optionally use a
managed service for PostgreSQL. For example, AWS offers a managed Relational
......@@ -21,14 +21,14 @@ This section is relevant for [Scaled Architecture](README.md#scalable-architectu
environments including [Basic Scaling](README.md#basic-scaling) and
[Full Scaling](README.md#full-scaling).
### Provide your own PostgreSQL instance **[CORE ONLY]**
### Provide your own PostgreSQL instance **(CORE ONLY)**
If you want to use your own deployed PostgreSQL instance(s),
see [Provide your own PostgreSQL instance](#provide-your-own-postgresql-instance-core-only)
for more details. However, you can use the GitLab Omnibus package to easily
deploy the bundled PostgreSQL.
### Standalone PostgreSQL using GitLab Omnibus **[CORE ONLY]**
### Standalone PostgreSQL using GitLab Omnibus **(CORE ONLY)**
1. SSH into the PostgreSQL server.
1. [Download/install](https://about.gitlab.com/installation) the Omnibus GitLab
......@@ -97,14 +97,14 @@ environments including [Horizontal](README.md#horizontal),
[Hybrid](README.md#hybrid), and
[Fully Distributed](README.md#fully-distributed).
### Provide your own PostgreSQL instance **[CORE ONLY]**
### Provide your own PostgreSQL instance **(CORE ONLY)**
If you want to use your own deployed PostgreSQL instance(s),
see [Provide your own PostgreSQL instance](#provide-your-own-postgresql-instance-core-only)
for more details. However, you can use the GitLab Omnibus package to easily
deploy the bundled PostgreSQL.
### High Availability with GitLab Omnibus **[PREMIUM ONLY]**
### High Availability with GitLab Omnibus **(PREMIUM ONLY)**
> Important notes:
>
......
doc/administration/high_availability/redis.md
View file @ 73c6477b
# Configuring Redis for Scaling and High Availability
## Provide your own Redis instance **[CORE ONLY]**
## Provide your own Redis instance **(CORE ONLY)**
The following are the requirements for providing your own Redis instance:
......@@ -20,14 +20,14 @@ This section is relevant for [Scaled Architecture](README.md#scalable-architectu
environments including [Basic Scaling](README.md#basic-scaling) and
[Full Scaling](README.md#full-scaling).
### Provide your own Redis instance **[CORE ONLY]**
### Provide your own Redis instance **(CORE ONLY)**
If you want to use your own deployed Redis instance(s),
see [Provide your own Redis instance](#provide-your-own-redis-instance-core-only)
for more details. However, you can use the GitLab Omnibus package to easily
deploy the bundled Redis.
### Standalone Redis using GitLab Omnibus **[CORE ONLY]**
### Standalone Redis using GitLab Omnibus **(CORE ONLY)**
The GitLab Omnibus package can be used to configure a standalone Redis server.
In this configuration Redis is not highly available, and represents a single
......@@ -89,14 +89,14 @@ environments including [Horizontal](README.md#horizontal),
[Hybrid](README.md#hybrid), and
[Fully Distributed](README.md#fully-distributed).
### Provide your own Redis instance **[CORE ONLY]**
### Provide your own Redis instance **(CORE ONLY)**
If you want to use your own deployed Redis instance(s),
see [Provide your own Redis instance](#provide-your-own-redis-instance-core-only)
for more details. However, you can use the GitLab Omnibus package to easily
deploy the bundled Redis.
### High Availability with GitLab Omnibus **[PREMIUM ONLY]**
### High Availability with GitLab Omnibus **(PREMIUM ONLY)**
> Experimental Redis Sentinel support was [introduced in GitLab 8.11][ce-1877].
Starting with 8.14, Redis Sentinel is no longer experimental.
......
doc/administration/incoming_email.md
View file @ 73c6477b
......@@ -11,7 +11,7 @@ GitLab has several features based on receiving incoming emails:
allow GitLab users to create a new merge request by sending an email to a
user-specific email address.
- [Service Desk](../user/project/service_desk.md): provide e-mail support to
your customers through GitLab. **[PREMIUM]**
your customers through GitLab. **(PREMIUM)**
## Requirements
......
doc/administration/index.md
View file @ 73c6477b
This diff is collapsed.
doc/administration/instance_review.md
View file @ 73c6477b
# Instance Review **[CORE ONLY]**
# Instance Review **(CORE ONLY)**
> [Introduced][6995] in [GitLab Core][ee] 11.3.
......
doc/administration/issue_closing_pattern.md
View file @ 73c6477b
# Issue closing pattern **[CORE ONLY]**
# Issue closing pattern **(CORE ONLY)**
>**Note:**
This is the administration documentation.
......
doc/administration/merge_request_diffs.md
View file @ 73c6477b
# Merge request diffs storage **[CORE ONLY]**
# Merge request diffs storage **(CORE ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/52568) in GitLab 11.8.
......
doc/administration/monitoring/prometheus/gitlab_metrics.md
View file @ 73c6477b
......@@ -49,7 +49,7 @@ The following metrics are available:
| unicorn_queued_connections | Gauge | 11.0 | The number of queued Unicorn connections |
| unicorn_workers | Gauge | 12.0 | The number of Unicorn workers |
## Sidekiq Metrics available for Geo **[PREMIUM]**
## Sidekiq Metrics available for Geo **(PREMIUM)**
Sidekiq jobs may also gather metrics, and these metrics can be accessed if the Sidekiq exporter is enabled (e.g. via
the `monitoring.sidekiq_exporter` configuration option in `gitlab.yml`.
......
doc/administration/operations/extra_sidekiq_processes.md
View file @ 73c6477b
# Extra Sidekiq processes **[STARTER ONLY]**
# Extra Sidekiq processes **(STARTER ONLY)**
NOTE: **Note:**
The information in this page applies only to Omnibus GitLab.
......
doc/administration/operations/fast_ssh_key_lookup.md
View file @ 73c6477b
......@@ -30,7 +30,7 @@ instructions will break installations using older versions of OpenSSH, such as
those included with CentOS 6 as of September 2017. If you want to use this
feature for CentOS 6, follow [the instructions on how to build and install a custom OpenSSH package](#compiling-a-custom-version-of-openssh-for-centos-6) before continuing.
## Fast lookup is required for Geo **[PREMIUM]**
## Fast lookup is required for Geo **(PREMIUM)**
By default, GitLab manages an `authorized_keys` file, which contains all the
public SSH keys for users allowed to access GitLab. However, to maintain a
......
doc/administration/operations/index.md
View file @ 73c6477b
......@@ -11,7 +11,7 @@ Keep your GitLab instance up and running smoothly.
by GitLab to another file system or another server.
- [Sidekiq MemoryKiller](sidekiq_memory_killer.md): Configure Sidekiq MemoryKiller
to restart Sidekiq.
- [Extra Sidekiq operations](extra_sidekiq_processes.md): Configure an extra set of Sidekiq processes to ensure certain queues always have dedicated workers, no matter the amount of jobs that need to be processed. **[STARTER ONLY]**
- [Extra Sidekiq operations](extra_sidekiq_processes.md): Configure an extra set of Sidekiq processes to ensure certain queues always have dedicated workers, no matter the amount of jobs that need to be processed. **(STARTER ONLY)**
- [Unicorn](unicorn.md): Understand Unicorn and unicorn-worker-killer.
- Speed up SSH operations by [Authorizing SSH users via a fast,
indexed lookup to the GitLab database](fast_ssh_key_lookup.md), and/or
......
doc/administration/packages.md
View file @ 73c6477b
# GitLab Packages administration **[PREMIUM ONLY]**
# GitLab Packages administration **(PREMIUM ONLY)**
GitLab Packages allows organizations to utilize GitLab as a private repository
for a variety of common package managers. Users are able to build and publish
......
doc/administration/pseudonymizer.md
View file @ 73c6477b
# Pseudonymizer **[ULTIMATE]**
# Pseudonymizer **(ULTIMATE)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5532) in [GitLab Ultimate][ee] 11.1.
......
doc/administration/raketasks/geo.md
View file @ 73c6477b
# Geo Rake Tasks **[PREMIUM ONLY]**
# Geo Rake Tasks **(PREMIUM ONLY)**
## Git housekeeping
......
doc/administration/raketasks/project_import_export.md
View file @ 73c6477b
# Project import/export administration **[CORE ONLY]**
# Project import/export administration **(CORE ONLY)**
>**Note:**
>
......
doc/administration/uploads.md
View file @ 73c6477b
......@@ -48,7 +48,7 @@ _The uploads are stored by default in
1. Save the file and [restart GitLab][] for the changes to take effect.
### Using object storage **[CORE ONLY]**
### Using object storage **(CORE ONLY)**
> **Notes:**
>
......
doc/api/README.md
View file @ 73c6477b
This diff is collapsed.
doc/api/boards.md
View file @ 73c6477b
......@@ -141,7 +141,7 @@ Example response:
}
```
## Create a board **[STARTER]**
## Create a board **(STARTER)**
Creates a board.
......@@ -209,7 +209,7 @@ Example response:
}
```
## Update a board **[STARTER]**
## Update a board **(STARTER)**
> [Introduced][ee-5954] in [GitLab Starter](https://about.gitlab.com/pricing/) 11.1.
......@@ -291,7 +291,7 @@ Example response:
}
```
## Delete a board **[STARTER]**
## Delete a board **(STARTER)**
Deletes a board.
......@@ -405,8 +405,8 @@ POST /projects/:id/boards/:board_id/lists
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
| `label_id` | integer | no | The ID of a label |
| `assignee_id` **[PREMIUM]** | integer | no | The ID of a user |
| `milestone_id` **[PREMIUM]** | integer | no | The ID of a milestone |
| `assignee_id` **(PREMIUM)** | integer | no | The ID of a user |
| `milestone_id` **(PREMIUM)** | integer | no | The ID of a milestone |
NOTE: **Note**:
Label, assignee and milestone arguments are mutually exclusive,
......
doc/api/discussions.md
View file @ 73c6477b
......@@ -4,7 +4,7 @@ Discussions are a set of related notes on:
- Snippets
- Issues
- Epics **[ULTIMATE]**
- Epics **(ULTIMATE)**
- Merge requests
- Commits
......@@ -430,7 +430,7 @@ Parameters:
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636
```
## Epics **[ULTIMATE]**
## Epics **(ULTIMATE)**
### List group epic discussions
......
doc/api/epic_issues.md
View file @ 73c6477b
# Epic Issues API **[ULTIMATE]**
# Epic Issues API **(ULTIMATE)**
Every API call to epic_issues must be authenticated.
......
doc/api/epic_links.md
View file @ 73c6477b
# Epic Links API **[ULTIMATE]**
# Epic Links API **(ULTIMATE)**
>**Note:**
> This endpoint was [introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9188) in GitLab 11.8.
......
doc/api/epics.md
View file @ 73c6477b
# Epics API **[ULTIMATE]**
# Epics API **(ULTIMATE)**
Every API call to epic must be authenticated.
......
doc/api/geo_nodes.md
View file @ 73c6477b
# Geo Nodes API **[PREMIUM ONLY]**
# Geo Nodes API **(PREMIUM ONLY)**
In order to interact with Geo node endpoints, you need to authenticate yourself
as an admin.
......
doc/api/graphql/index.md
View file @ 73c6477b
......@@ -46,7 +46,7 @@ curl --data "value=100" --header "PRIVATE-TOKEN: <your_access_token>" https://gi
A first iteration of a GraphQL API includes the following queries
1. `project` : Within a project it is also possible to fetch a `mergeRequest` by IID.
1. `group` : Basic group information and epics **[ULTIMATE]** are currently supported.
1. `group` : Basic group information and epics **(ULTIMATE)** are currently supported.
1. `namespace` : Within a namespace it is also possible to fetch `projects`.
### Multiplex queries
......
doc/api/group_boards.md
View file @ 73c6477b
......@@ -236,7 +236,7 @@ Example response:
}
```
## Create a group issue board **[PREMIUM]**
## Create a group issue board **(PREMIUM)**
Creates a Group Issue Board.
......@@ -300,7 +300,7 @@ Example response:
}
```
## Update a group issue board **[PREMIUM]**
## Update a group issue board **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5954) in GitLab 11.1.
......@@ -368,7 +368,7 @@ Example response:
}
```
## Delete a group issue board **[PREMIUM]**
## Delete a group issue board **(PREMIUM)**
Deletes a Group Issue Board.
......
doc/api/group_milestones.md
View file @ 73c6477b
......@@ -137,7 +137,7 @@ Parameters:
[ce-12819]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/12819
## Get all burndown chart events for a single milestone **[STARTER]**
## Get all burndown chart events for a single milestone **(STARTER)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1
......
doc/api/groups.md
View file @ 73c6477b
......@@ -434,8 +434,8 @@ Parameters:
| `lfs_enabled` | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. |
| `request_access_enabled` | boolean | no | Allow users to request member access. |
| `parent_id` | integer | no | The parent group ID for creating nested group. |
| `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group. |
| `extra_shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Extra pipeline minutes quota for this group. |
| `shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Pipeline minutes quota for this group. |
| `extra_shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Extra pipeline minutes quota for this group. |
## Transfer project to group
......@@ -466,14 +466,14 @@ PUT /groups/:id
| `name` | string | no | The name of the group. |
| `path` | string | no | The path of the group. |
| `description` | string | no | The description of the group. |
| `membership_lock` | boolean | no | **[STARTER]** Prevent adding new members to project membership within this group. |
| `membership_lock` | boolean | no | **(STARTER)** Prevent adding new members to project membership within this group. |
| `share_with_group_lock` | boolean | no | Prevent sharing a project with another group within this group. |
| `visibility` | string | no | The visibility level of the group. Can be `private`, `internal`, or `public`. |
| `lfs_enabled` (optional) | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. |
| `request_access_enabled` | boolean | no | Allow users to request member access. |
| `file_template_project_id` | integer | no | **[PREMIUM]** The ID of a project to load custom file templates from. |
| `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group. |
| `extra_shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Extra pipeline minutes quota for this group. |
| `file_template_project_id` | integer | no | **(PREMIUM)** The ID of a project to load custom file templates from. |
| `shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Pipeline minutes quota for this group. |
| `extra_shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Extra pipeline minutes quota for this group. |
```bash
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5?name=Experimental"
......@@ -573,7 +573,7 @@ GET /groups?search=foobar
]
```
## Sync group with LDAP **[CORE ONLY]**
## Sync group with LDAP **(CORE ONLY)**
Syncs the group with its linked LDAP group. Only available to group owners and administrators.
......@@ -589,7 +589,7 @@ Parameters:
Please consult the [Group Members](members.md) documentation.
### Add LDAP group link **[CORE ONLY]**
### Add LDAP group link **(CORE ONLY)**
Adds an LDAP group link.
......@@ -604,7 +604,7 @@ Parameters:
- `group_access` (required) - Minimum access level for members of the LDAP group
- `provider` (required) - LDAP provider for the LDAP group
### Delete LDAP group link **[CORE ONLY]**
### Delete LDAP group link **(CORE ONLY)**
Deletes an LDAP group link.
......
doc/api/issue_links.md
View file @ 73c6477b
# Issue links API **[STARTER]**
# Issue links API **(STARTER)**
## List issue relations
......
doc/api/issues.md
View file @ 73c6477b
......@@ -47,7 +47,7 @@ GET /issues?confidential=true
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `weight` **[STARTER]** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `iids[]` | integer array | no | Return only the issues having the given `iid` |
| `order_by` | string | no | Return issues ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
......@@ -198,7 +198,7 @@ GET /groups/:id/issues?confidential=true
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `weight` **[STARTER]** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `order_by` | string | no | Return issues ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search group issues against their `title` and `description` |
......@@ -347,7 +347,7 @@ GET /projects/:id/issues?confidential=true
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `weight` **[STARTER]** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `order_by` | string | no | Return issues ordered by `created_at` or `updated_at` fields. Default is `created_at` |
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search project issues against their `title` and `description` |
......@@ -603,7 +603,7 @@ POST /projects/:id/issues
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.|
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
| `weight` **[STARTER]** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. |
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. |
```bash
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug
......@@ -703,7 +703,7 @@ PUT /projects/:id/issues/:issue_iid
| `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it |
| `updated_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `weight` **[STARTER]** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 |
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 |
| `discussion_locked` | boolean | no | Flag indicating if the issue's discussion is locked. If the discussion is locked only project members can add or edit comments. |
```bash
......
doc/api/jobs.md
View file @ 73c6477b
......@@ -359,7 +359,7 @@ GET /projects/:id/jobs/:job_id/artifacts
|-------------|----------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
| `job_id` | integer | yes | ID of a job. |
| `job_token` **[PREMIUM]** | string | no | To be used with [triggers] for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`. |
| `job_token` **(PREMIUM)** | string | no | To be used with [triggers] for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`. |
Example request using the `PRIVATE-TOKEN` header:
......@@ -368,7 +368,7 @@ curl --output artifacts.zip --header "PRIVATE-TOKEN: <your_access_token>" "https
```
To use this in a [`script` definition](../ci/yaml/README.md#script) inside
`.gitlab-ci.yml` **[PREMIUM]**, you can use either:
`.gitlab-ci.yml` **(PREMIUM)**, you can use either:
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job will download the artifacts of the job with ID
......@@ -425,7 +425,7 @@ Parameters
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
| `ref_name` | string | yes | Branch or tag name in repository. HEAD or SHA references are not supported. |
| `job` | string | yes | The name of the job. |
| `job_token` **[PREMIUM]** | string | no | To be used with [triggers] for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`. |
| `job_token` **(PREMIUM)** | string | no | To be used with [triggers] for multi-project pipelines. It should be invoked only inside `.gitlab-ci.yml`. Its value is always `$CI_JOB_TOKEN`. |
Example request using the `PRIVATE-TOKEN` header:
......@@ -434,7 +434,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
```
To use this in a [`script` definition](../ci/yaml/README.md#script) inside
`.gitlab-ci.yml` **[PREMIUM]**, you can use either:
`.gitlab-ci.yml` **(PREMIUM)**, you can use either:
- The `JOB-TOKEN` header with the GitLab-provided `CI_JOB_TOKEN` variable.
For example, the following job will download the artifacts of the `test` job
......
doc/api/license.md
View file @ 73c6477b
# License **[CORE ONLY]**
# License **(CORE ONLY)**
In order to interact with license endpoints, you need to authenticate yourself
as an admin.
......
doc/api/managed_licenses.md
View file @ 73c6477b
# Managed Licenses API **[ULTIMATE]**
# Managed Licenses API **(ULTIMATE)**
## List managed licenses
......
doc/api/merge_request_approvals.md
View file @ 73c6477b
# Merge request approvals API **[STARTER]**
# Merge request approvals API **(STARTER)**
Configuration for approvals on all Merge Requests (MR) in the project. Must be authenticated for all endpoints.
......@@ -359,7 +359,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/approve
| `id` | integer | yes | The ID of a project |
| `merge_request_iid` | integer | yes | The IID of MR |
| `sha` | string | no | The HEAD of the MR |
| `approval_password` **[STARTER]** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/merge_request_approvals.md#require-authentication-when-approving-a-merge-request-starter) is enabled in the project settings. |
| `approval_password` **(STARTER)** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/merge_request_approvals.md#require-authentication-when-approving-a-merge-request-starter) is enabled in the project settings. |
The `sha` parameter works in the same way as
when [accepting a merge request](merge_requests.md#accept-mr): if it is passed, then it must
......
doc/api/merge_requests.md
View file @ 73c6477b
......@@ -44,7 +44,7 @@ Parameters:
| `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead. |
| `author_id` | integer | no | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me` |
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. |
| `approver_ids` **[STARTER]** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `approver_ids` **(STARTER)** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `source_branch` | string | no | Return merge requests with the given source branch |
| `target_branch` | string | no | Return merge requests with the given target branch |
......@@ -206,7 +206,7 @@ Parameters:
| `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13060] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
| `approver_ids` **[STARTER]** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `approver_ids` **(STARTER)** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `source_branch` | string | no | Return merge requests with the given source branch |
| `target_branch` | string | no | Return merge requests with the given target branch |
......@@ -358,7 +358,7 @@ Parameters:
| `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> |
| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ |
| `approver_ids` **[STARTER]** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `approver_ids` **(STARTER)** | Array[integer] | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. |
| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
| `source_branch` | string | no | Return merge requests with the given source branch |
| `target_branch` | string | no | Return merge requests with the given target branch |
......@@ -846,7 +846,7 @@ POST /projects/:id/merge_requests
| `allow_maintainer_to_push` | boolean | no | Deprecated, see allow_collaboration |
| `squash` | boolean | no | Squash commits into a single commit when merging |
If `approvals_before_merge` **[STARTER]** is not provided, it inherits the value from the
If `approvals_before_merge` **(STARTER)** is not provided, it inherits the value from the
target project. If it is provided, then the following conditions must hold in
order for it to take effect:
......@@ -2261,6 +2261,6 @@ Example response:
[ce-15454]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15454
[ce-18935]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/18935
## Approvals **[STARTER]**
## Approvals **(STARTER)**
For approvals, please see [Merge Request Approvals](merge_request_approvals.md)
doc/api/milestones.md
View file @ 73c6477b
......@@ -148,7 +148,7 @@ Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `milestone_id` (required) - The ID of a project milestone
## Get all burndown chart events for a single milestone **[STARTER]**
## Get all burndown chart events for a single milestone **(STARTER)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1
......
doc/api/namespaces.md
View file @ 73c6477b
......@@ -68,7 +68,7 @@ the `plan` parameter associated with a namespace:
]
```
NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **[BRONZE ONLY]**.
NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**.
## Search for namespace
......
doc/api/notes.md
View file @ 73c6477b
......@@ -5,7 +5,7 @@ Notes are comments on:
- Snippets
- Issues
- Merge requests
- Epics **[ULTIMATE]**
- Epics **(ULTIMATE)**
This includes system notes, which are notes about changes to the object (for example, when a milestone changes, there will be a corresponding system note). Label notes are not part of this API, but recorded as separate events in [resource label events](resource_label_events.md).
......@@ -396,7 +396,7 @@ Parameters:
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602
```
## Epics **[ULTIMATE]**
## Epics **(ULTIMATE)**
### List all epic notes
......
doc/api/notification_settings.md
View file @ 73c6477b
......@@ -31,7 +31,7 @@ If the `custom` level is used, specific email events can be controlled. Availabl
- `merge_merge_request`
- `failed_pipeline`
- `success_pipeline`
- `new_epic` **[ULTIMATE]**
- `new_epic` **(ULTIMATE)**
## Global notification settings
......@@ -84,7 +84,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.
| `merge_merge_request` | boolean | no | Enable/disable this notification |
| `failed_pipeline` | boolean | no | Enable/disable this notification |
| `success_pipeline` | boolean | no | Enable/disable this notification |
| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6626) in 11.3) **[ULTIMATE]** |
| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6626) in 11.3) **(ULTIMATE)** |
Example response:
......@@ -153,7 +153,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.
| `merge_merge_request` | boolean | no | Enable/disable this notification |
| `failed_pipeline` | boolean | no | Enable/disable this notification |
| `success_pipeline` | boolean | no | Enable/disable this notification |
| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6626) in 11.3) **[ULTIMATE]** |
| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6626) in 11.3) **(ULTIMATE)** |
Example responses:
......
doc/api/packages.md
View file @ 73c6477b
# Packages API **[PREMIUM]**
# Packages API **(PREMIUM)**
This is the API docs of [GitLab Packages](../administration/packages.md).
......
doc/api/project_aliases.md
View file @ 73c6477b
# Project Aliases API **[PREMIUM ONLY]**
# Project Aliases API **(PREMIUM ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/3264) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1.
......
doc/api/project_clusters.md
View file @ 73c6477b
......@@ -167,7 +167,7 @@ Parameters:
| `platform_kubernetes_attributes[ca_cert]` | String | no | TLS certificate (needed if API is using a self-signed TLS certificate |
| `platform_kubernetes_attributes[namespace]` | String | no | The unique namespace related to the project |
| `platform_kubernetes_attributes[authorization_type]` | String | no | The cluster authorization type: `rbac`, `abac` or `unknown_authorization`. Defaults to `rbac`. |
| `environment_scope` | String | no | The associated environment to the cluster. Defaults to `*` **[PREMIUM]** |
| `environment_scope` | String | no | The associated environment to the cluster. Defaults to `*` **(PREMIUM)** |
Example request:
......@@ -257,7 +257,7 @@ Parameters:
| `platform_kubernetes_attributes[token]` | String | no | The token to authenticate against Kubernetes |
| `platform_kubernetes_attributes[ca_cert]` | String | no | TLS certificate (needed if API is using a self-signed TLS certificate |
| `platform_kubernetes_attributes[namespace]` | String | no | The unique namespace related to the project |
| `environment_scope` | String | no | The associated environment to the cluster **[PREMIUM]** |
| `environment_scope` | String | no | The associated environment to the cluster **(PREMIUM)** |
NOTE: **Note:**
`name`, `api_url`, `ca_cert` and `token` can only be updated if the cluster was added
......
doc/api/project_level_variables.md
View file @ 73c6477b
......@@ -74,7 +74,7 @@ POST /projects/:id/variables
| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` |
| `protected` | boolean | no | Whether the variable is protected |
| `masked` | boolean | no | Whether the variable is masked |
| `environment_scope` | string | no | The `environment_scope` of the variable **[PREMIUM]** |
| `environment_scope` | string | no | The `environment_scope` of the variable **(PREMIUM)** |
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"
......@@ -108,7 +108,7 @@ PUT /projects/:id/variables/:key
| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` |
| `protected` | boolean | no | Whether the variable is protected |
| `masked` | boolean | no | Whether the variable is masked |
| `environment_scope` | string | no | The `environment_scope` of the variable **[PREMIUM]** |
| `environment_scope` | string | no | The `environment_scope` of the variable **(PREMIUM)** |
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables/NEW_VARIABLE" --form "value=updated value"
......
doc/api/project_templates.md
View file @ 73c6477b
......@@ -16,7 +16,7 @@ Support will be added for [Issue and Merge Request templates](../user/project/de
in a future release.
Support for [Group-level file templates](../user/group/index.md#group-file-templates-premium)
**[PREMIUM]** was [added](https://gitlab.com/gitlab-org/gitlab-ee/issues/5987)
**(PREMIUM)** was [added](https://gitlab.com/gitlab-org/gitlab-ee/issues/5987)
in GitLab 11.5
## Get all templates of a particular type
......
doc/api/projects.md
View file @ 73c6477b
This diff is collapsed.
doc/api/protected_branches.md
View file @ 73c6477b
......@@ -166,9 +166,9 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitla
| `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) |
| `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) |
| `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) |
| `allowed_to_push` | array | no | **[STARTER]** Array of access levels allowed to push, with each described by a hash |
| `allowed_to_merge` | array | no | **[STARTER]** Array of access levels allowed to merge, with each described by a hash |
| `allowed_to_unprotect` | array | no | **[STARTER]**Array of access levels allowed to unprotect, with each described by a hash |
| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash |
| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash |
| `allowed_to_unprotect` | array | no | **(STARTER)**Array of access levels allowed to unprotect, with each described by a hash |
Example response:
......@@ -229,7 +229,7 @@ Example response:
}
```
### Example with user / group level access **[STARTER]**
### Example with user / group level access **(STARTER)**
Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the
form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in ][ee-3516] in GitLab 10.3 EE.
......
doc/api/resource_label_events.md
View file @ 73c6477b
......@@ -88,7 +88,7 @@ Parameters:
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1
```
## Epics **[ULTIMATE]**
## Epics **(ULTIMATE)**
### List group epic label events
......
doc/api/scim.md
View file @ 73c6477b
# SCIM API **[SILVER ONLY]**
# SCIM API **(SILVER ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9388) in [GitLab Silver](https://about.gitlab.com/pricing/) 11.10.
......
doc/api/search.md
View file @ 73c6477b
......@@ -19,7 +19,7 @@ GET /search
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, snippet_blobs, users.
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md). **[STARTER]**
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md). **(STARTER)**
The response depends on the requested scope.
......@@ -283,7 +283,7 @@ Example response:
]
```
### Scope: wiki_blobs **[STARTER]**
### Scope: wiki_blobs **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......@@ -308,7 +308,7 @@ Example response:
]
```
### Scope: commits **[STARTER]**
### Scope: commits **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......@@ -341,7 +341,7 @@ Example response:
]
```
### Scope: blobs **[STARTER]**
### Scope: blobs **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......@@ -415,7 +415,7 @@ GET /groups/:id/search
Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users.
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md). **[STARTER]**
If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs and commits. Find more about [the feature](../integration/elasticsearch.md). **(STARTER)**
The response depends on the requested scope.
......@@ -617,7 +617,7 @@ Example response:
]
```
### Scope: wiki_blobs **[STARTER]**
### Scope: wiki_blobs **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......@@ -642,7 +642,7 @@ Example response:
]
```
### Scope: commits **[STARTER]**
### Scope: commits **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......@@ -675,7 +675,7 @@ Example response:
]
```
### Scope: blobs **[STARTER]**
### Scope: blobs **(STARTER)**
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
......
doc/api/services.md
View file @ 73c6477b
......@@ -1146,7 +1146,7 @@ Get JetBrains TeamCity CI service settings for a project.
GET /projects/:id/services/teamcity
```
## Jenkins CI **[STARTER]**
## Jenkins CI **(STARTER)**
A continuous integration and build server
......
doc/api/settings.md
View file @ 73c6477b
This diff is collapsed.
doc/api/users.md
View file @ 73c6477b
......@@ -359,8 +359,8 @@ Parameters:
- `external` (optional) - Flags the user as external - true or false(default)
- `avatar` (optional) - Image file for user's avatar
- `private_profile` (optional) - User's profile is private - true or false
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **[STARTER]**
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **[STARTER]**
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)**
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)**
## User modification
......@@ -396,8 +396,8 @@ Parameters:
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user
- `avatar` (optional) - Image file for user's avatar
- `private_profile` (optional) - User's profile is private - true or false
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **[STARTER]**
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **[STARTER]**
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)**
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)**
On password update, user will be forced to change it upon next login.
Note, at the moment this method does only return a `404` error,
......
doc/api/vulnerabilities.md
View file @ 73c6477b
# Vulnerabilities API **[ULTIMATE]**
# Vulnerabilities API **(ULTIMATE)**
Every API call to vulnerabilities must be authenticated.
......
doc/ci/README.md
View file @ 73c6477b
......@@ -104,27 +104,27 @@ Its feature set is listed on the table below according to DevOps stages.
| **Verify** ||
| [Browser Performance Testing](../user/project/merge_requests/browser_performance_testing.md) | Quickly determine the performance impact of pending code changes. |
| [CI services](services/README.md) | Link Docker containers with your base image.|
| [Code Quality](../user/project/merge_requests/code_quality.md) **[STARTER]** | Analyze your source code quality. |
| [GitLab CI/CD for external repositories](ci_cd_for_external_repos/index.md) **[PREMIUM]** | Get the benefits of GitLab CI/CD combined with repositories in GitHub and BitBucket Cloud. |
| [Interactive Web Terminals](interactive_web_terminal/index.md) **[CORE ONLY]** | Open an interactive web terminal to debug the running jobs. |
| [Code Quality](../user/project/merge_requests/code_quality.md) **(STARTER)** | Analyze your source code quality. |
| [GitLab CI/CD for external repositories](ci_cd_for_external_repos/index.md) **(PREMIUM)** | Get the benefits of GitLab CI/CD combined with repositories in GitHub and BitBucket Cloud. |
| [Interactive Web Terminals](interactive_web_terminal/index.md) **(CORE ONLY)** | Open an interactive web terminal to debug the running jobs. |
| [JUnit tests](junit_test_reports.md) | Identify script failures directly on merge requests. |
| [Using Docker images](docker/using_docker_images.md) | Use GitLab and GitLab Runner with Docker to build and test applications. |
|---+---|
| **Release** ||
| [Auto Deploy](../topics/autodevops/index.md#auto-deploy) | Deploy your application to a production environment in a Kubernetes cluster. |
| [Building Docker images](docker/using_docker_build.md) | Maintain Docker-based projects using GitLab CI/CD. |
| [Canary Deployments](../user/project/canary_deployments.md) **[PREMIUM]** | Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature. |
| [Deploy Boards](../user/project/deploy_boards.md) **[PREMIUM]** | Check the current health and status of each CI/CD environment running on Kubernetes. |
| [Feature Flags](../user/project/operations/feature_flags.md) **[PREMIUM]** | Deploy your features behind Feature Flags. |
| [Canary Deployments](../user/project/canary_deployments.md) **(PREMIUM)** | Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature. |
| [Deploy Boards](../user/project/deploy_boards.md) **(PREMIUM)** | Check the current health and status of each CI/CD environment running on Kubernetes. |
| [Feature Flags](../user/project/operations/feature_flags.md) **(PREMIUM)** | Deploy your features behind Feature Flags. |
| [GitLab Pages](../user/project/pages/index.md) | Deploy static websites. |
| [GitLab Releases](../user/project/releases/index.md) | Add release notes to Git tags. |
| [Review Apps](review_apps/index.md) | Configure GitLab CI/CD to preview code changes. |
|---+---|
| **Secure** ||
| [Container Scanning](../user/application_security/container_scanning/index.md) **[ULTIMATE]** | Check your Docker containers for known vulnerabilities.|
| [Dependency Scanning](../user/application_security/dependency_scanning/index.md) **[ULTIMATE]** | Analyze your dependencies for known vulnerabilities. |
| [License Management](../user/application_security/license_management/index.md) **[ULTIMATE]** | Search your project dependencies for their licenses. |
| [Security Test reports](../user/project/merge_requests/index.md#security-reports-ultimate) **[ULTIMATE]** | Check for app vulnerabilities. |
| [Container Scanning](../user/application_security/container_scanning/index.md) **(ULTIMATE)** | Check your Docker containers for known vulnerabilities.|
| [Dependency Scanning](../user/application_security/dependency_scanning/index.md) **(ULTIMATE)** | Analyze your dependencies for known vulnerabilities. |
| [License Management](../user/application_security/license_management/index.md) **(ULTIMATE)** | Search your project dependencies for their licenses. |
| [Security Test reports](../user/project/merge_requests/index.md#security-reports-ultimate) **(ULTIMATE)** | Check for app vulnerabilities. |
## Examples
......@@ -133,7 +133,7 @@ on the [CI Examples](examples/README.md) page.
GitLab also provides [example projects](https://gitlab.com/gitlab-examples) pre-configured to use GitLab CI/CD.
## Administration **[CORE ONLY]**
## Administration **(CORE ONLY)**
As a GitLab administrator, you can change the default behavior
of GitLab CI/CD for:
......
doc/ci/ci_cd_for_external_repos/bitbucket_integration.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: howto
---
# Using GitLab CI/CD with a Bitbucket Cloud repository **[PREMIUM]**
# Using GitLab CI/CD with a Bitbucket Cloud repository **(PREMIUM)**
GitLab CI/CD can be used with Bitbucket Cloud by:
......
doc/ci/ci_cd_for_external_repos/github_integration.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: howto
---
# Using GitLab CI/CD with a GitHub repository **[PREMIUM]**
# Using GitLab CI/CD with a GitHub repository **(PREMIUM)**
GitLab CI/CD can be used with **GitHub.com** and **GitHub Enterprise** by
creating a [CI/CD project](index.md) to connect your GitHub repository to
......
doc/ci/ci_cd_for_external_repos/index.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: index, howto
---
# GitLab CI/CD for external repositories **[PREMIUM]**
# GitLab CI/CD for external repositories **(PREMIUM)**
>[Introduced][ee-4642] in [GitLab Premium][eep] 10.6.
......
doc/ci/environments.md
View file @ 73c6477b
......@@ -673,7 +673,7 @@ fetch line:
fetch = +refs/environments/*:refs/remotes/origin/environments/*
```
### Scoping environments with specs **[PREMIUM]**
### Scoping environments with specs **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/2112) in [GitLab Premium](https://about.gitlab.com/pricing/) 9.4.
......@@ -692,7 +692,7 @@ with `review/` would have that particular variable.
Some GitLab features can behave differently for each environment.
For example, you can
[create a secret variable to be injected only into a production environment](variables/README.md#limiting-environment-scopes-of-environment-variables-premium). **[PREMIUM]**
[create a secret variable to be injected only into a production environment](variables/README.md#limiting-environment-scopes-of-environment-variables-premium). **(PREMIUM)**
In most cases, these features use the _environment specs_ mechanism, which offers
an efficient way to implement scoping within each environment group.
......@@ -734,7 +734,7 @@ Below are some links you may find interesting:
- [The `.gitlab-ci.yml` definition of environments](yaml/README.md#environment)
- [A blog post on Deployments & Environments](https://about.gitlab.com/2016/08/26/ci-deployment-and-environments/)
- [Review Apps - Use dynamic environments to deploy your code for every branch](review_apps/index.md)
- [Deploy Boards for your applications running on Kubernetes](../user/project/deploy_boards.md) **[PREMIUM]**
- [Deploy Boards for your applications running on Kubernetes](../user/project/deploy_boards.md) **(PREMIUM)**
<!-- ## Troubleshooting
......
doc/ci/environments/protected_environments.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: concepts, howto
---
# Protected Environments **[PREMIUM]**
# Protected Environments **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6303) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.3.
......
doc/ci/examples/README.md
View file @ 73c6477b
......@@ -45,7 +45,7 @@ language users and GitLab by sending a merge request with a guide for that langu
You may want to apply for the [GitLab Community Writers Program](https://about.gitlab.com/community/writers/)
to get paid for writing complete articles for GitLab.
## Adding templates to your GitLab installation **[PREMIUM ONLY]**
## Adding templates to your GitLab installation **(PREMIUM ONLY)**
If you want to have customized examples and templates for your own self-managed GitLab instance available to your team, your GitLab administrator can [designate an instance template repository](../../user/admin_area/settings/instance_template_repository.md) that contains examples and templates specific to your enterprise.
......
doc/ci/interactive_web_terminal/index.md
View file @ 73c6477b
......@@ -59,7 +59,7 @@ close the terminal window.
![finished job with terminal open](img/finished_job_with_terminal_open.png)
## Interactive Web Terminals for the Web IDE **[ULTIMATE ONLY]**
## Interactive Web Terminals for the Web IDE **(ULTIMATE ONLY)**
Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md).
doc/ci/introduction/index.md
View file @ 73c6477b
......@@ -177,22 +177,22 @@ according to each stage (Verify, Package, Release).
1. **Verify**:
- Automatically build and test your application with Continuous Integration.
- Analyze your source code quality with [GitLab Code Quality](../../user/project/merge_requests/code_quality.md). **[STARTER]**
- Determine the performance impact of code changes with [Browser Performance Testing](../../user/project/merge_requests/browser_performance_testing.md). **[PREMIUM]**
- Perform a series of tests, such as [Container Scanning](../../user/application_security/container_scanning/index.md) **[ULTIMATE]**, [Dependency Scanning](../../user/application_security/dependency_scanning/index.md) **[ULTIMATE]**, and [JUnit tests](../junit_test_reports.md).
- Analyze your source code quality with [GitLab Code Quality](../../user/project/merge_requests/code_quality.md). **(STARTER)**
- Determine the performance impact of code changes with [Browser Performance Testing](../../user/project/merge_requests/browser_performance_testing.md). **(PREMIUM)**
- Perform a series of tests, such as [Container Scanning](../../user/application_security/container_scanning/index.md) **(ULTIMATE)**, [Dependency Scanning](../../user/application_security/dependency_scanning/index.md) **(ULTIMATE)**, and [JUnit tests](../junit_test_reports.md).
- Deploy your changes with [Review Apps](../review_apps/index.md) to preview the app changes on every branch.
1. **Package**:
- Store Docker images with [Container Registry](../../user/project/container_registry.md).
- Store NPM packages with [NPM Registry](../../user/project/packages/npm_registry.md). **[PREMIUM]**
- Store Maven artifacts with [Maven Repository](../../user/project/packages/maven_repository.md). **[PREMIUM]**
- Store NPM packages with [NPM Registry](../../user/project/packages/npm_registry.md). **(PREMIUM)**
- Store Maven artifacts with [Maven Repository](../../user/project/packages/maven_repository.md). **(PREMIUM)**
1. **Release**:
- Continuous Deployment, automatically deploying your app to production.
- Continuous Delivery, manually click to deploy your app to production.
- Deploy static websites with [GitLab Pages](../../user/project/pages/index.md).
- Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature with [Canary Deployments](../../user/project/canary_deployments.md). **[PREMIUM]**
- Deploy your features behind [Feature Flags](../../user/project/operations/feature_flags.md). **[PREMIUM]**
- Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature with [Canary Deployments](../../user/project/canary_deployments.md). **(PREMIUM)**
- Deploy your features behind [Feature Flags](../../user/project/operations/feature_flags.md). **(PREMIUM)**
- Add release notes to any Git tag with [GitLab Releases](../../user/project/releases/index.md).
- View of the current health and status of each CI environment running on Kubernetes with [Deploy Boards](../../user/project/deploy_boards.md). **[PREMIUM]**
- View of the current health and status of each CI environment running on Kubernetes with [Deploy Boards](../../user/project/deploy_boards.md). **(PREMIUM)**
- Deploy your application to a production environment in a Kubernetes cluster with [Auto Deploy](../../topics/autodevops/index.md#auto-deploy).
With GitLab CI/CD you can also:
......@@ -201,7 +201,7 @@ With GitLab CI/CD you can also:
- Deploy your app to different [environments](../environments.md).
- Install your own [GitLab Runner](https://docs.gitlab.com/runner/).
- [Schedule pipelines](../../user/project/pipelines/schedules.md).
- Check for app vulnerabilities with [Security Test reports](../../user/project/merge_requests/index.md#security-reports-ultimate). **[ULTIMATE]**
- Check for app vulnerabilities with [Security Test reports](../../user/project/merge_requests/index.md#security-reports-ultimate). **(ULTIMATE)**
To see all CI/CD features, navigate back to the [CI/CD index](../README.md).
......
doc/ci/merge_request_pipelines/index.md
View file @ 73c6477b
......@@ -76,11 +76,11 @@ when a merge request was created or updated. For example:
![Merge request page](img/merge_request.png)
## Pipelines for Merged Results **[PREMIUM]**
## Pipelines for Merged Results **(PREMIUM)**
Read the [documentation on Pipelines for Merged Results](pipelines_for_merged_results/index.md).
### Merge Trains **[PREMIUM]**
### Merge Trains **(PREMIUM)**
Read the [documentation on Merge Trains](pipelines_for_merged_results/merge_trains/index.md).
......
doc/ci/merge_request_pipelines/pipelines_for_merged_results/index.md
View file @ 73c6477b
......@@ -3,7 +3,7 @@ type: reference
last_update: 2019-07-03
---
# Pipelines for Merged Results **[PREMIUM]**
# Pipelines for Merged Results **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/7380) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.10.
> This feature is disabled by default until we resolve issues with [contention handling](https://gitlab.com/gitlab-org/gitlab-ee/issues/11222), but [can be enabled manually](#enabling-pipelines-for-merged-results).
......@@ -61,7 +61,7 @@ CAUTION: **Warning:**
Make sure your `gitlab-ci.yml` file is [configured properly for pipelines for merge requests](../index.md#configuring-pipelines-for-merge-requests),
otherwise pipelines for merged results won't run and your merge requests will be stuck in an unresolved state.
## Merge Trains **[PREMIUM]**
## Merge Trains **(PREMIUM)**
Read the [documentation on Merge Trains](merge_trains/index.md).
......
doc/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md
View file @ 73c6477b
......@@ -3,7 +3,7 @@ type: reference
last_update: 2019-07-03
---
# Merge Trains **[PREMIUM]**
# Merge Trains **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9186) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.0.
> This feature is disabled by default, but [can be enabled manually](#enabling-merge-trains).
......
doc/ci/metrics_reports.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: reference
---
# Metrics Reports **[PREMIUM]**
# Metrics Reports **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/9788) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.10.
Requires GitLab Runner 11.10 and above.
......
doc/ci/multi_project_pipelines.md
View file @ 73c6477b
......@@ -2,7 +2,7 @@
type: reference
---
# Multi-project pipelines **[PREMIUM]**
# Multi-project pipelines **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/2121) in
[GitLab Premium 9.3](https://about.gitlab.com/2017/06/22/gitlab-9-3-released/#multi-project-pipeline-graphs).
......
doc/ci/pipelines.md
View file @ 73c6477b
......@@ -234,7 +234,7 @@ Pipeline status and test coverage report badges are available and configurable f
For information on adding pipeline badges to projects, see [Pipeline badges](../user/project/pipelines/settings.md#pipeline-badges).
## Multi-project pipelines **[PREMIUM]**
## Multi-project pipelines **(PREMIUM)**
Pipelines for different projects can be combined and visualized together.
......
doc/ci/review_apps/index.md
View file @ 73c6477b
......@@ -154,7 +154,7 @@ After adding Review Apps to your workflow, you follow the branched Git flow. Tha
1. Wait for the Runner to build and deploy your web application.
1. Click on the link that provided in the merge request related to the branch to see the changes live.
### Visual Reviews **[STARTER]**
### Visual Reviews **(STARTER)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/10761) in GitLab Starter 12.0.
......
doc/ci/triggers/README.md
View file @ 73c6477b
......@@ -32,7 +32,7 @@ to protect trigger tokens.
You can use the `CI_JOB_TOKEN` [variable][predef] (used to authenticate
with the [GitLab Container Registry][registry]) in the following cases.
#### When used with multi-project pipelines **[PREMIUM]**
#### When used with multi-project pipelines **(PREMIUM)**
> **Note**:
The use of `CI_JOB_TOKEN` for multi-project pipelines was [introduced][ee-2017]
......@@ -56,7 +56,7 @@ Pipelines triggered that way also expose a special variable:
Read more about the [pipelines trigger API][trigapi].
#### When a pipeline depends on the artifacts of another pipeline **[PREMIUM]**
#### When a pipeline depends on the artifacts of another pipeline **(PREMIUM)**
> The use of `CI_JOB_TOKEN` in the artifacts download API was [introduced][ee-2346]
in [GitLab Premium][ee] 9.5.
......
doc/ci/variables/README.md
View file @ 73c6477b
This diff is collapsed.
doc/ci/yaml/README.md
View file @ 73c6477b
This diff is collapsed.
doc/customization/index.md
View file @ 73c6477b
This diff is collapsed.
doc/development/documentation/styleguide.md
View file @ 73c6477b
This diff is collapsed.
doc/development/elasticsearch.md
View file @ 73c6477b
This diff is collapsed.
doc/development/geo.md
View file @ 73c6477b
This diff is collapsed.
doc/development/go_guide/index.md
View file @ 73c6477b
This diff is collapsed.
doc/development/packages.md
View file @ 73c6477b
This diff is collapsed.
doc/development/rake_tasks.md
View file @ 73c6477b
This diff is collapsed.
doc/gitlab-basics/create-project.md
View file @ 73c6477b
This diff is collapsed.
doc/install/README.md
View file @ 73c6477b
This diff is collapsed.
doc/install/pivotal/index.md
View file @ 73c6477b
This diff is collapsed.
doc/integration/elasticsearch.md
View file @ 73c6477b
This diff is collapsed.
doc/integration/jenkins.md
View file @ 73c6477b
This diff is collapsed.
doc/integration/jira_development_panel.md
View file @ 73c6477b
This diff is collapsed.
doc/integration/kerberos.md
View file @ 73c6477b
This diff is collapsed.
doc/push_rules/push_rules.md
View file @ 73c6477b
This diff is collapsed.
doc/raketasks/web_hooks.md
View file @ 73c6477b
This diff is collapsed.
doc/tools/email.md
View file @ 73c6477b
This diff is collapsed.
doc/topics/authentication/index.md
View file @ 73c6477b
This diff is collapsed.
doc/topics/autodevops/index.md
View file @ 73c6477b
This diff is collapsed.
doc/topics/autodevops/quick_start_guide.md
View file @ 73c6477b
This diff is collapsed.
doc/update/patch_versions.md
View file @ 73c6477b
This diff is collapsed.
doc/update/upgrading_from_ce_to_ee.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/geo_nodes.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/labels.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/license.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/settings/email.md
View file @ 73c6477b
This diff is collapsed.
doc/user/admin_area/settings/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/application_security/dast/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/application_security/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/application_security/sast/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/discussions/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/clusters/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/custom_project_templates.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/dependency_proxy/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/epics/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/insights/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/issues_analytics/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/roadmap/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/saml_sso/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/group/saml_sso/scim_setup.md
View file @ 73c6477b
This diff is collapsed.
doc/user/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/markdown.md
View file @ 73c6477b
This diff is collapsed.
doc/user/operations_dashboard/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/permissions.md
View file @ 73c6477b
This diff is collapsed.
doc/user/profile/preferences.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/canary_deployments.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/clusters/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/code_owners.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/deploy_boards.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/description_templates.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/file_lock.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/import/gemnasium.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/import/github.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/import/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/insights/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/integrations/github.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/integrations/prometheus.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/issue_board.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/issues/csv_export.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/issues/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/issues/managing_issues.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/issues/related_issues.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/labels.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/merge_requests/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/milestones/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/operations/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/operations/tracing.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/packages/npm_registry.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/pages/introduction.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/protected_branches.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/quick_actions.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/repository/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/service_desk.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/settings/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/project/web_ide/index.md
View file @ 73c6477b
This diff is collapsed.
doc/user/search/advanced_global_search.md
View file @ 73c6477b
This diff is collapsed.
doc/user/search/advanced_search_syntax.md
View file @ 73c6477b
This diff is collapsed.
doc/user/search/index.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/README.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/issue_weight.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/notifications.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/repository_mirroring.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/shortcuts.md
View file @ 73c6477b
This diff is collapsed.
doc/workflow/todos.md
View file @ 73c6477b
This diff is collapsed.
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7