summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-06-05 00:08:38 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-06-05 00:08:38 +0000
commit38a00c219fffa802ffaa26689fc7912b59165ddc (patch)
treebb1f6a3525a7559fa1033ee4e8f9cead9402f270 /doc
parent37c8b3b44e6d3f5755e45b3db6913fab7fee5c89 (diff)
downloadgitlab-ce-38a00c219fffa802ffaa26689fc7912b59165ddc.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/auth/ldap/img/multi_login.gifbin180218 -> 321518 bytes
-rw-r--r--doc/administration/auth/ldap/index.md11
-rw-r--r--doc/ci/jenkins/index.md2
-rw-r--r--doc/development/documentation/styleguide.md2
-rw-r--r--doc/development/integrations/jenkins.md2
-rw-r--r--doc/gitlab-basics/start-using-git.md2
-rw-r--r--doc/integration/vault.md4
-rw-r--r--doc/ssh/README.md2
-rw-r--r--doc/topics/authentication/index.md2
-rw-r--r--doc/user/group/bulk_editing/index.md87
-rw-r--r--doc/user/group/epics/img/bulk_editing.pngbin72912 -> 0 bytes
-rw-r--r--doc/user/group/epics/index.md2
-rw-r--r--doc/user/group/epics/manage_epics.md13
-rw-r--r--doc/user/project/bulk_editing.md62
-rw-r--r--doc/user/project/clusters/serverless/aws.md2
-rw-r--r--doc/user/project/integrations/img/related_links_v13_1.pngbin0 -> 4086 bytes
-rw-r--r--doc/user/project/integrations/prometheus.md38
17 files changed, 164 insertions, 67 deletions
diff --git a/doc/administration/auth/ldap/img/multi_login.gif b/doc/administration/auth/ldap/img/multi_login.gif
index d317add9837..5aee6090793 100644
--- a/doc/administration/auth/ldap/img/multi_login.gif
+++ b/doc/administration/auth/ldap/img/multi_login.gif
Binary files differ
diff --git a/doc/administration/auth/ldap/index.md b/doc/administration/auth/ldap/index.md
index 278cfc5d6cc..e8801879018 100644
--- a/doc/administration/auth/ldap/index.md
+++ b/doc/administration/auth/ldap/index.md
@@ -413,10 +413,21 @@ gitlab_rails['ldap_servers'] = {
'host' => 'ad-secondary.example.net',
'port' => 636,
...
+ },
+
+'tertiary' => {
+ 'label' => 'GitLab Tertiary AD',
+ 'host' => 'ad-tertiary.example.net',
+ 'port' => 636,
+ ...
}
+
}
```
+NOTE: **Note:**
+Any number of LDAP servers can be configured. However, make sure to use a unique naming convention for the `label` section of each entry as this will be the display name of the tab shown on the sign-in page.
+
## User sync **(STARTER ONLY)**
Once per day, GitLab runs a worker to check and update GitLab
diff --git a/doc/ci/jenkins/index.md b/doc/ci/jenkins/index.md
index 8eeab6f6c2e..72839f74aeb 100644
--- a/doc/ci/jenkins/index.md
+++ b/doc/ci/jenkins/index.md
@@ -210,7 +210,7 @@ which can be used by projects in that instance.
Declarative Jenkinsfiles contain "Sections" and "Directives" which are used to control the behavior of your
pipelines. There are equivalents for all of these in GitLab, which we've documented below.
-This section is based on the [Jenkinsfile syntax documentation](http://www.jenkins.io/doc/book/pipeline/syntax/)
+This section is based on the [Jenkinsfile syntax documentation](https://www.jenkins.io/doc/book/pipeline/syntax/)
and is meant to be a mapping of concepts there to concepts in GitLab.
### Sections
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index ddd7ee39155..ea1837c034c 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -1049,7 +1049,7 @@ of language classes available.
| `xml` | |
| `yaml` | Alias: `yml`. |
-For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/engineering/ux/technical-writing/markdown-guide/#code-blocks).
+For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/markdown-guide/#code-blocks).
## GitLab SVG icons
diff --git a/doc/development/integrations/jenkins.md b/doc/development/integrations/jenkins.md
index 3d6f314c02b..f2bc6532dde 100644
--- a/doc/development/integrations/jenkins.md
+++ b/doc/development/integrations/jenkins.md
@@ -1,6 +1,6 @@
# How to run Jenkins in development environment (on macOS) **(STARTER)**
-This is a step by step guide on how to set up [Jenkins](http://www.jenkins.io/) on your local machine and connect to it from your GitLab instance. GitLab triggers webhooks on Jenkins, and Jenkins connects to GitLab using the API. By running both applications on the same machine, we can make sure they are able to access each other.
+This is a step by step guide on how to set up [Jenkins](https://www.jenkins.io/) on your local machine and connect to it from your GitLab instance. GitLab triggers webhooks on Jenkins, and Jenkins connects to GitLab using the API. By running both applications on the same machine, we can make sure they are able to access each other.
## Install Jenkins
diff --git a/doc/gitlab-basics/start-using-git.md b/doc/gitlab-basics/start-using-git.md
index 21f43e359e0..212443a431c 100644
--- a/doc/gitlab-basics/start-using-git.md
+++ b/doc/gitlab-basics/start-using-git.md
@@ -50,7 +50,7 @@ prompt, terminal, and command line) of your preference. Here are some suggestion
- [iTerm2](https://www.iterm2.com/), which you can integrate with [zsh](https://git-scm.com/book/id/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Zsh) and [oh my zsh](https://ohmyz.sh/) for color highlighting, among other handy features for Git users.
- For Windows users:
- Built-in: **cmd**. Click the search icon on the bottom navbar on Windows and type "cmd" to find it.
- - [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell): a Windows "powered up" shell, from which you can execute a greater number of commands.
+ - [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7): a Windows "powered up" shell, from which you can execute a greater number of commands.
- Git Bash: it comes built into [Git for Windows](https://gitforwindows.org/).
- For Linux users:
- Built-in: [Linux Terminal](https://www.howtogeek.com/140679/beginner-geek-how-to-start-using-the-linux-terminal/).
diff --git a/doc/integration/vault.md b/doc/integration/vault.md
index f26c3df93f8..cead8f7592a 100644
--- a/doc/integration/vault.md
+++ b/doc/integration/vault.md
@@ -69,7 +69,7 @@ The following assumes you already have Vault installed and running.
1. **Write the OIDC Role Config:**
- Now that Vault has a GitLab application ID and secret, it needs to know the [**Redirect URIs**](https://www.vaultproject.io/docs/auth/jwt/#redirect-uris) and scopes given to GitLab during the application creation process. The redirect URIs need to match where your Vault instance is running. The `oidc_scopes` field needs to include the `openid`. Similarly to the previous step, replace `your_application_id` with the generated application ID from GitLab:
+ Now that Vault has a GitLab application ID and secret, it needs to know the [**Redirect URIs**](https://www.vaultproject.io/docs/auth/jwt#redirect-uris) and scopes given to GitLab during the application creation process. The redirect URIs need to match where your Vault instance is running. The `oidc_scopes` field needs to include the `openid`. Similarly to the previous step, replace `your_application_id` with the generated application ID from GitLab:
This configuration is saved under the name of the role you are creating. In this case, we are creating a `demo` role. Later, we'll show how you can access this role through the Vault CLI.
@@ -110,7 +110,7 @@ The following assumes you already have Vault installed and running.
1. In the **Write the OIDC Role Config** (step 4), we created a role called `demo`. We set `role=demo` so Vault knows which configuration we'd like to login in with.
1. To set Vault to use the `OIDC` sign-in method, we set `-method=oidc`.
- 1. To set the port that GitLab should redirect to, we set `port=8250` or another port number that matches the port given to GitLab when listing [Redirect URIs](https://www.vaultproject.io/docs/auth/jwt/#redirect-uris).
+ 1. To set the port that GitLab should redirect to, we set `port=8250` or another port number that matches the port given to GitLab when listing [Redirect URIs](https://www.vaultproject.io/docs/auth/jwt#redirect-uris).
Once you run the command above, it will present a link in the terminal.
Click the link in the terminal and a tab will open in the browser confirming you're signed into Vault via OIDC:
diff --git a/doc/ssh/README.md b/doc/ssh/README.md
index 595c426d1db..6b9f6340cc6 100644
--- a/doc/ssh/README.md
+++ b/doc/ssh/README.md
@@ -412,7 +412,7 @@ are *explicitly not supported* and may stop working at any time.
### Options for Microsoft Windows
-If you're running Windows 10, the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10), and its latest [WSL 2](https://docs.microsoft.com/install-win10) version,
+If you're running Windows 10, the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install-win10), and its latest [WSL 2](https://docs.microsoft.com/en-us/install-win10) version,
support the installation of different Linux distributions, which include the Git and SSH clients.
For current versions of Windows, you can also install the Git and SSH clients with
diff --git a/doc/topics/authentication/index.md b/doc/topics/authentication/index.md
index eca37b5f73a..6ce5e203bbf 100644
--- a/doc/topics/authentication/index.md
+++ b/doc/topics/authentication/index.md
@@ -44,5 +44,5 @@ This page gathers all the resources for the topic **Authentication** within GitL
- [Kanboard Plugin GitLab Authentication](https://github.com/kanboard/plugin-gitlab-auth)
- [Jenkins GitLab OAuth Plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+OAuth+Plugin)
-- [How to customize GitLab to support OpenID authentication](https://eric.van-der-vlist.com/blog/2013/11/23/how-to-customize-gitlab-to-support-openid-authentication//)
+- [How to customize GitLab to support OpenID authentication](https://blog.eric.van-der-vlist.com/2013/11/23/how-to-customize-gitlab-to-support-openid-authentication/)
- [OKD - Configuring Authentication and User Agent](https://docs.okd.io/3.11/install_config/configuring_authentication.html#GitLab)
diff --git a/doc/user/group/bulk_editing/index.md b/doc/user/group/bulk_editing/index.md
index 5547bacb809..c4ccc1f7b52 100644
--- a/doc/user/group/bulk_editing/index.md
+++ b/doc/user/group/bulk_editing/index.md
@@ -1,31 +1,74 @@
-# Bulk editing issues, merge requests, and epics at the group level **(PREMIUM)**
+---
+stage: Plan
+group: Project Management
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+---
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7249) for issues in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1.
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12719) for merge requests in [GitLab Premium](https://about.gitlab.com/pricing/) 12.2.
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7250) for epics in [GitLab Premium](https://about.gitlab.com/pricing/) 12.2.
+# Bulk editing issues, epics, and merge requests at the group level **(PREMIUM)**
-## Editing milestones and labels
+NOTE: **Note:**
+Bulk editing issues and merge requests is also available at the **project level**.
+For more details, see [Bulk editing issues, epics, and merge requests](../../project/bulk_editing.md).
-> **Notes:**
->
-> - A permission level of `Reporter` or higher is required in order to manage issues.
-> - A permission level of `Developer` or higher is required in order to manage merge requests.
-> - A permission level of `Reporter` or higher is required in order to manage epics.
+If you want to update attributes across multiple issues, epics, or merge requests in a group, you
+can do it by bulk editing them, that is, editing them together.
-By using the bulk editing feature:
+![Bulk editing](img/bulk-editing.png)
-- Milestones can be updated simultaneously across multiple issues or merge requests.
-- Labels can be updated simultaneously across multiple issues, merge requests, or epics.
+## Bulk edit issues at the group level
-![Bulk editing](img/bulk-editing.png)
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7249) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1.
+
+NOTE: **Note:**
+You need a permission level of [Reporter or higher](../../permissions.md) to manage issues.
+
+When bulk editing issues in a group, you can edit the following attributes:
+
+- Milestone
+- Labels
+
+To update multiple project issues at the same time:
+
+1. In a group, go to **{issues}** **Issues > List**.
+1. Click **Edit issues**. A sidebar on the right-hand side of your screen appears with editable fields.
+1. Select the checkboxes next to each issue you want to edit.
+1. Select the appropriate fields and their values from the sidebar.
+1. Click **Update all**.
+
+## Bulk edit epics
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7250) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.2.
+
+NOTE: **Note:**
+You need a permission level of [Reporter or higher](../../permissions.md) to manage epics.
+
+When bulk editing epics in a group, you can edit their labels.
+
+To update multiple epics at the same time:
+
+1. In a group, go to **{epic}** **Epics > List**.
+1. Click **Edit epics**. A sidebar on the right-hand side of your screen appears with editable fields.
+1. Check the checkboxes next to each epic you want to edit.
+1. Select the appropriate fields and their values from the sidebar.
+1. Click **Update all**.
+
+## Bulk edit merge requests at the group level
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12719) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.2.
+
+NOTE: **Note:**
+You need a permission level of [Developer or higher](../../permissions.md) to manage merge requests.
+
+When bulk editing merge requests in a group, you can edit the following attributes:
+
+- Milestone
+- Labels
-To bulk update group issues, merge requests, or epics:
+To update multiple group merge requests at the same time:
-1. Navigate to the issues, merge requests, or epics list.
-1. Click **Edit issues**, **Edit merge requests**, or **Edit epics**.
- - This will open a sidebar on the right-hand side where editable fields
- for milestones and labels will be displayed.
- - Checkboxes will also appear beside each issue, merge request, or epic.
-1. Check the checkbox beside each issue, merge request, or epic to be edited.
-1. Select the desired new values from the sidebar.
+1. In a group, go to **{merge-request}** **Merge Requests**.
+1. Click **Edit merge requests**. A sidebar on the right-hand side of your screen appears with
+ editable fields.
+1. Select the checkboxes next to each merge request you want to edit.
+1. Select the appropriate fields and their values from the sidebar.
1. Click **Update all**.
diff --git a/doc/user/group/epics/img/bulk_editing.png b/doc/user/group/epics/img/bulk_editing.png
deleted file mode 100644
index 85610bef83e..00000000000
--- a/doc/user/group/epics/img/bulk_editing.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md
index d33fcad4007..85164292265 100644
--- a/doc/user/group/epics/index.md
+++ b/doc/user/group/epics/index.md
@@ -28,7 +28,7 @@ milestones.
To learn what you can do with an epic, see [Manage epics](manage_epics.md). Possible actions include:
- [Create an epic](manage_epics.md#create-an-epic)
-- [Bulk-edit epics](manage_epics.md#bulk-edit-epics)
+- [Bulk-edit epics](../bulk_editing/index.md#bulk-edit-epics)
- [Delete an epic](manage_epics.md#delete-an-epic)
- [Close an epic](manage_epics.md#close-an-epic)
- [Reopen a closed epic](manage_epics.md#reopen-a-closed-epic)
diff --git a/doc/user/group/epics/manage_epics.md b/doc/user/group/epics/manage_epics.md
index f19a55559f9..26d5cb51e01 100644
--- a/doc/user/group/epics/manage_epics.md
+++ b/doc/user/group/epics/manage_epics.md
@@ -43,17 +43,8 @@ An epic's page contains the following tabs:
## Bulk-edit epics
-You can edit multiple epics at once. For example, to apply labels to multiple epics:
-
-1. Go to the Epics list.
-1. Click **Edit epics**.
- - Checkboxes appear next to each epic.
- - A sidebar on the right-hand side appears with an editable field for labels.
-1. Select the checkbox next to each epic to be edited.
-1. Select the labels you want.
-1. Click **Update all**.
-
-![bulk editing](img/bulk_editing.png)
+You can edit multiple epics at once. To learn how to do it, visit
+[Bulk editing issues, epics, and merge requests at the group level](../bulk_editing/index.md#bulk-edit-epics).
## Delete an epic
diff --git a/doc/user/project/bulk_editing.md b/doc/user/project/bulk_editing.md
index 14a570fa17d..6d091c431a2 100644
--- a/doc/user/project/bulk_editing.md
+++ b/doc/user/project/bulk_editing.md
@@ -4,37 +4,57 @@ group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
-# Bulk editing issues, epics, and merge requests
+# Bulk editing issues and merge requests at the project level
-> **Notes:**
->
-> - A permission level of `Reporter` or higher is required in order to manage
-> issues.
-> - A permission level of `Reporter` or higher is required in order to manage
-> epics.
-> - A permission level of `Developer` or higher is required in order to manage
-> merge requests.
+NOTE: **Note:**
+Bulk editing issues, epics, and merge requests is also available at the **group level**.
+For more details, see
+[Bulk editing issues, epics, and merge requests at the group level](../group/bulk_editing/index.md).
-Attributes can be updated simultaneously across multiple issues, epics, or merge requests
-by using the bulk editing feature.
+If you want to update attributes across multiple issues or merge requests, you can do it
+by bulk editing them, that is, editing them together.
![Bulk editing](img/bulk-editing.png)
+## Bulk edit issues at the project level
+
NOTE: **Note:**
-Bulk editing issues, epics, and merge requests is also available at the group level.
-For more details, see [bulk editing group issues and merge requests](../group/bulk_editing/index.md).
+You need a permission level of [Reporter or higher](../permissions.md) to manage issues.
+
+When bulk editing issues in a project, you can edit the following attributes:
+
+- Status (open/closed)
+- Assignee
+- Milestone
+- Labels
+- Subscriptions
-To update multiple project issues, epics, or merge requests at the same time:
+To update multiple project issues at the same time:
-1. Navigate to their respective list.
+1. In a project, go to **{issues}** **Issues > List**.
+1. Click **Edit issues**. A sidebar on the right-hand side of your screen appears with editable fields.
+1. Select the checkboxes next to each issue you want to edit.
+1. Select the appropriate fields and their values from the sidebar.
+1. Click **Update all**.
+
+## Bulk edit merge requests at the project level
+
+NOTE: **Note:**
+You need a permission level of [Developer or higher](../permissions.md) to manage merge requests.
-1. Click either **Edit issues**, **Edit epics**, or **Edit merge requests**.
+When bulk editing merge requests in a project, you can edit the following attributes:
- - This will open a sidebar on the right-hand side of your screen
- where editable fields will be displayed.
+- Status (open/closed)
+- Assignee
+- Milestone
+- Labels
+- Subscriptions
- - Checkboxes will also appear beside each issue or merge request.
+To update multiple project merge requests at the same time:
-1. Check the checkboxes of each items to be edited.
-1. Choose the appropriate fields and their values from the sidebar.
+1. In a project, go to **{merge-request}** **Merge Requests**.
+1. Click **Edit merge requests**. A sidebar on the right-hand side of your screen appears with
+ editable fields.
+1. Select the checkboxes next to each merge request you want to edit.
+1. Select the appropriate fields and their values from the sidebar.
1. Click **Update all**.
diff --git a/doc/user/project/clusters/serverless/aws.md b/doc/user/project/clusters/serverless/aws.md
index c26f622836c..15f7e14fda9 100644
--- a/doc/user/project/clusters/serverless/aws.md
+++ b/doc/user/project/clusters/serverless/aws.md
@@ -15,7 +15,7 @@ GitLab supports deployment of AWS Lambda functions through GitLab CI/CD using th
## Serverless Framework
-The [Serverless Framework can deploy to AWS](https://serverless.com/framework/docs/providers/aws/).
+The [Serverless Framework can deploy to AWS](https://www.serverless.com/framework/docs/providers/aws/).
We have prepared an example with a step-by-step guide to create a simple function and deploy it on AWS.
diff --git a/doc/user/project/integrations/img/related_links_v13_1.png b/doc/user/project/integrations/img/related_links_v13_1.png
new file mode 100644
index 00000000000..4dc141f0e7f
--- /dev/null
+++ b/doc/user/project/integrations/img/related_links_v13_1.png
Binary files differ
diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md
index 0eb8cc61505..70fd0cb6780 100644
--- a/doc/user/project/integrations/prometheus.md
+++ b/doc/user/project/integrations/prometheus.md
@@ -378,16 +378,26 @@ The following tables outline the details of expected properties.
| ------ | ------ | ------ | ------ |
| `dashboard` | string | yes | Heading for the dashboard. Only one dashboard should be defined per file. |
| `panel_groups` | array | yes | The panel groups which should be on the dashboard. |
-| `templating` | Hash | no | Top level key under which templating related options can be added. |
+| `templating` | hash | no | Top level key under which templating related options can be added. |
+| `links` | array | no | Add links to display on the dashboard. |
##### **Templating (`templating`) properties**
| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
-| `variables` | Hash | no | Variables can be defined here. |
+| `variables` | hash | no | Variables can be defined here. |
Read the documentation on [templating](#templating-variables-for-metrics-dashboards).
+##### **Links (`links`) properties**
+
+| Property | Type | Required | Description |
+| -------- | ---- | -------- | ----------- |
+| `url` | string | yes | The address of the link. |
+| `title` | string | no | Display title for the link. |
+
+Read the documentation on [links](#add-related-links-to-custom-dashboards).
+
##### **Panel group (`panel_groups`) properties**
| Property | Type | Required | Description |
@@ -802,7 +812,7 @@ templating:
###### Full syntax
-This example creates a variable called `variable1`, with a default value of `var1_option_2`.
+This example creates a variable called `variable1`, with a default value of `value_option_2`.
The label for the text box on the UI will be the value of the `label` key.
The dashboard UI will display a dropdown with `Option 1` and `Option 2`
as the choices.
@@ -825,6 +835,28 @@ templating:
default: true # (Optional) This option should be the default value of this variable.
```
+### Add related links to custom dashboards
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216385) in GitLab 13.1.
+
+Related links can be added to the top of your metrics dashboard, which can be used for quickly
+navigating between dashboards or external services. The links will open in the same tab.
+
+The `url` attribute is required for the link but the `title` attribute is optional; if the `title`
+is missing then the full address of the URL will be displayed.
+
+![Links UI](img/related_links_v13_1.png)
+
+#### Links Syntax
+
+```yaml
+links:
+ - title: GitLab.com
+ url: https://gitlab.com
+ - title: GitLab Documentation
+ url: https://docs.gitlab.com
+```
+
### View and edit the source file of a custom dashboard
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34779) in GitLab 12.5.