summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-12-09 15:12:56 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-12-09 15:12:56 +0000
commit750deb250143d48aba32fb437ba8838fbef3fde3 (patch)
tree4927e37f0bd061e72fcb281b068e8e4b8e417245 /doc
parent15f5da601b5dd687f9fc1a1da71d791c8c3e6411 (diff)
downloadgitlab-ce-750deb250143d48aba32fb437ba8838fbef3fde3.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/object_storage.md5
-rw-r--r--doc/administration/package_information/deprecation_policy.md2
-rw-r--r--doc/ci/pipelines/job_artifacts.md2
-rw-r--r--doc/integration/jenkins.md4
-rw-r--r--doc/system_hooks/system_hooks.md6
-rw-r--r--doc/user/admin_area/settings/account_and_limit_settings.md2
-rw-r--r--doc/user/application_security/api_fuzzing/index.md2
-rw-r--r--doc/user/application_security/dast_api/index.md2
-rw-r--r--doc/user/group/planning_hierarchy/index.md2
-rw-r--r--doc/user/project/working_with_projects.md98
10 files changed, 67 insertions, 58 deletions
diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md
index 9f720fb680a..c6490e365a5 100644
--- a/doc/administration/object_storage.md
+++ b/doc/administration/object_storage.md
@@ -281,6 +281,9 @@ The service account must have permission to access the bucket. Learn more
in Google's
[Cloud Storage authentication documentation](https://cloud.google.com/storage/docs/authentication).
+NOTE:
+Bucket encryption with the [Cloud Key Management Service (KMS)](https://cloud.google.com/kms/docs) is not supported and will result in [ETag mismatch errors](#etag-mismatch).
+
##### Google example (consolidated form)
For Omnibus installations, this is an example of the `connection` setting:
@@ -682,6 +685,8 @@ With the consolidated object configuration and instance profile, Workhorse has
S3 credentials so that it can compute the `Content-MD5` header. This
eliminates the need to compare ETag headers returned from the S3 server.
+Encrypting buckets with GCS' [Cloud Key Management Service (KMS)](https://cloud.google.com/kms/docs) is not supported and will result in ETag mismatch errors.
+
### Using Amazon instance profiles
Instead of supplying AWS access and secret keys in object storage
diff --git a/doc/administration/package_information/deprecation_policy.md b/doc/administration/package_information/deprecation_policy.md
index 164c0eb5c07..905de387dcb 100644
--- a/doc/administration/package_information/deprecation_policy.md
+++ b/doc/administration/package_information/deprecation_policy.md
@@ -82,7 +82,7 @@ The final comment in the issue **has to have**:
## Example
-User configuration available in `/etc/gitlab/gitlab.rb` was introduced in GitLab version 10.0, `gitlab_rails['configuration'] = true`. In GitLab version 10.4.0, a new change was introduced that requires rename of this configuration option. New configuration option is `gitlab_rails['better_configuration'] = true`. Development team translates the old configuration into a new one
+User configuration available in `/etc/gitlab/gitlab.rb` was introduced in GitLab version 10.0, `gitlab_rails['configuration'] = true`. In GitLab version 10.4.0, a new change was introduced that requires rename of this configuration option. New configuration option is `gitlab_rails['better_configuration'] = true`. Development team translates the old configuration into a new one
and triggers a deprecation procedure.
This means that these two configuration
diff --git a/doc/ci/pipelines/job_artifacts.md b/doc/ci/pipelines/job_artifacts.md
index f3b28c343a0..e47b6dddc5f 100644
--- a/doc/ci/pipelines/job_artifacts.md
+++ b/doc/ci/pipelines/job_artifacts.md
@@ -379,7 +379,7 @@ By default artifacts are always kept for the most recent successful pipeline for
each ref. This means that the latest artifacts do not immediately expire according
to the `expire_in` specification.
-If a new pipeline for the same ref completes successfully, the previous pipeline's
+If a new pipeline for the same ref completes successfully, the previous pipeline's
artifacts are deleted according to the `expire_in` configuration. The artifacts
of the new pipeline are kept automatically.
diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md
index 01df49c6c0b..822530775e5 100644
--- a/doc/integration/jenkins.md
+++ b/doc/integration/jenkins.md
@@ -181,9 +181,9 @@ to integrate GitLab and Jenkins.
### Error during GitLab configuration - "Connection failed. Please check your settings"
-If you get this error message while configuring GitLab, the following are possible causes:
+If you get this error message while configuring GitLab, the following are possible causes:
-- GitLab is unable to reach your Jenkins instance at the address. If your GitLab instance is self-managed, try pinging the
+- GitLab is unable to reach your Jenkins instance at the address. If your GitLab instance is self-managed, try pinging the
Jenkins instance at the domain provided on the GitLab instance.
- The Jenkins instance is at a local address and is not included in the
[GitLab installation's allowlist](../security/webhooks.md#allowlist-for-local-requests).
diff --git a/doc/system_hooks/system_hooks.md b/doc/system_hooks/system_hooks.md
index dcab56a0d0f..72106a00191 100644
--- a/doc/system_hooks/system_hooks.md
+++ b/doc/system_hooks/system_hooks.md
@@ -44,6 +44,10 @@ denied access.
System hooks can be used, for example, for logging or changing information in an
LDAP server.
+In addition to these default events, you can enable triggers for other events,
+such as push events, and disable the `repository_update` event
+when you create a system hook.
+
NOTE:
We follow the same structure and deprecations as [Webhooks](../user/project/integrations/webhooks.md)
for Push and Tag events, but we never display commits.
@@ -55,7 +59,7 @@ To create a system hook:
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **System Hooks**.
1. Provide the **URL** and **Secret Token**.
-1. Select the checkbox next to each **Trigger** you want to enable.
+1. Select the checkbox next to each optional **Trigger** you want to enable.
1. Select **Enable SSL verification**, if desired.
1. Click **Add system hook**.
diff --git a/doc/user/admin_area/settings/account_and_limit_settings.md b/doc/user/admin_area/settings/account_and_limit_settings.md
index fc707c266f9..a6ad311da38 100644
--- a/doc/user/admin_area/settings/account_and_limit_settings.md
+++ b/doc/user/admin_area/settings/account_and_limit_settings.md
@@ -194,7 +194,7 @@ To set a limit on how long these sessions are valid:
## Limit the lifetime of SSH keys **(ULTIMATE SELF)**
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1007) in GitLab 14.6 [with a flag](../../../administration/feature_flags.md) named `ff_limit_ssh_key_lifetime`. Disabled by default.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1007) in GitLab 14.6 [with a flag](../../../administration/feature_flags.md) named `ff_limit_ssh_key_lifetime`. Disabled by default.
> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/346753) in GitLab 14.6.
FLAG:
diff --git a/doc/user/application_security/api_fuzzing/index.md b/doc/user/application_security/api_fuzzing/index.md
index 2d8fa78f793..749ae93a542 100644
--- a/doc/user/application_security/api_fuzzing/index.md
+++ b/doc/user/application_security/api_fuzzing/index.md
@@ -1302,7 +1302,7 @@ Please use `~"Category:API Security"` [label](../../../development/contributing/
[Search the issue tracker](https://gitlab.com/gitlab-org/gitlab/-/issues) for similar entries before submitting your own, there's a good chance somebody else had the same issue or feature proposal. Show your support with an award emoji and or join the discussion.
-When experiencing a behavior not working as expected, consider providing contextual information:
+When experiencing a behavior not working as expected, consider providing contextual information:
- GitLab version if using a self-managed instance.
- `.gitlab-ci.yml` job definition.
diff --git a/doc/user/application_security/dast_api/index.md b/doc/user/application_security/dast_api/index.md
index da6cb817518..0db5fb2d868 100644
--- a/doc/user/application_security/dast_api/index.md
+++ b/doc/user/application_security/dast_api/index.md
@@ -1218,7 +1218,7 @@ Please use `~"Category:API Security"` [label](../../../development/contributing/
[Search the issue tracker](https://gitlab.com/gitlab-org/gitlab/-/issues) for similar entries before submitting your own, there's a good chance somebody else had the same issue or feature proposal. Show your support with an award emoji and or join the discussion.
-When experiencing a behavior not working as expected, consider providing contextual information:
+When experiencing a behavior not working as expected, consider providing contextual information:
- GitLab version if using a self-managed instance.
- `.gitlab-ci.yml` job definition.
diff --git a/doc/user/group/planning_hierarchy/index.md b/doc/user/group/planning_hierarchy/index.md
index 805b1e607bb..5887328abe4 100644
--- a/doc/user/group/planning_hierarchy/index.md
+++ b/doc/user/group/planning_hierarchy/index.md
@@ -47,7 +47,7 @@ classDiagram
class Issue
Epic *-- "0..7" Epic
- Epic "1" *-- "0..*" Issue
+Epic "1"*-- "0..*" Issue
```
-->
diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md
index 76932bb7f2e..9469dead0dc 100644
--- a/doc/user/project/working_with_projects.md
+++ b/doc/user/project/working_with_projects.md
@@ -16,9 +16,9 @@ To explore projects:
1. On the top bar, select **Menu > Projects**.
1. Select **Explore projects**.
-GitLab displays a list of projects, sorted by last updated date.
+GitLab displays a list of projects, sorted by last updated date.
-- To view projects with the most [stars](#star-a-project), select **Most stars**.
+- To view projects with the most [stars](#star-a-project), select **Most stars**.
- To view projects with the largest number of comments in the past month, select **Trending**.
NOTE:
@@ -45,15 +45,15 @@ If you're an instance administrator, you can administer all project topics from
To create a project in GitLab:
-1. On the top bar, select **Menu > Project**.
+1. On the top bar, select **Menu > Project**.
1. Select **Create new project**.
1. On the **New project** page, choose if you want to:
- Create a [blank project](#create-a-blank-project).
- Create a project from a:
- - [built-in template](#create-a-project-from-a-built-in-template).
+ - [built-in template](#create-a-project-from-a-built-in-template).
- [custom template](#create-a-project-from-a-custom-template).
- [HIPAA audit protocol template](#create-a-project-from-the-hipaa-audit-protocol-template).
- - [Import a project](../../user/project/import/index.md)
+ - [Import a project](../../user/project/import/index.md)
from a different repository. Contact your GitLab administrator if this option is not available.
- [Connect an external repository to GitLab CI/CD](../../ci/ci_cd_for_external_repos/index.md).
@@ -65,23 +65,23 @@ For a list of words that can't be used as project names see
To create a blank project:
-1. On the top bar, select **Menu > Project**.
+1. On the top bar, select **Menu > Project**.
1. Select **Create new project**.
1. Select **Create blank project**.
1. Enter the project details:
- - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
- underscores, and emoji. You cannot use special characters. After you enter the name,
+ - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
+ underscores, and emoji. You cannot use special characters. After you enter the name,
the **Project slug** populates.
- - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
- slug as the URL path to the project. To change the slug, first enter the project name,
- then change the slug.
+ - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
+ slug as the URL path to the project. To change the slug, first enter the project name,
+ then change the slug.
- In the **Project description (optional)** field, enter the description of your project's dashboard.
- - To modify the project's [viewing and access rights](../../public_access/public_access.md) for
+ - To modify the project's [viewing and access rights](../../public_access/public_access.md) for
users, change the **Visibility Level**.
- To create README file so that the Git repository is initialized, has a default branch, and
can be cloned, select **Initialize repository with a README**.
- - To analyze the source code in the project for known security vulnerabilities,
- select **Enable Static Application Security Testing (SAST)**.
+ - To analyze the source code in the project for known security vulnerabilities,
+ select **Enable Static Application Security Testing (SAST)**.
1. Select **Create project**.
## Create a project from a built-in template
@@ -104,16 +104,16 @@ To create a project from a built-in template:
- To view a preview of the template, select **Preview**.
- To use a template for the project, select **Use template**.
1. Enter the project details:
- - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
- underscores, and emoji. You cannot use special characters. After you enter the name,
+ - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
+ underscores, and emoji. You cannot use special characters. After you enter the name,
the **Project slug** populates.
- - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
- slug as the URL path to the project. To change the slug, first enter the project name,
- then change the slug.
+ - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
+ slug as the URL path to the project. To change the slug, first enter the project name,
+ then change the slug.
- In the **Project description (optional)** field, enter the description of your project's dashboard.
- - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
+ - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
change the **Visibility Level**.
-1. Select **Create project**.
+1. Select **Create project**.
## Create a project from a custom template **(PREMIUM)**
@@ -124,7 +124,7 @@ Custom project templates are available at:
- The [instance-level](../../user/admin_area/custom_project_templates.md)
- The [group-level](../../user/group/custom_project_templates.md)
-1. On the top bar, select **Menu > Project**.
+1. On the top bar, select **Menu > Project**.
1. Select **Create new project**.
1. Select **Create from template**.
1. Select the **Instance** or **Group** tab.
@@ -132,14 +132,14 @@ Custom project templates are available at:
- To view a preview of the template, select **Preview**.
- To use a template for the project, select **Use template**.
1. Enter the project details:
- - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
- underscores, and emoji. You cannot use special characters. After you enter the name,
+ - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
+ underscores, and emoji. You cannot use special characters. After you enter the name,
the **Project slug** populates.
- - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
- slug as the URL path to the project. To change the slug, first enter the project name,
- then change the slug.
+ - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
+ slug as the URL path to the project. To change the slug, first enter the project name,
+ then change the slug.
- The description of your project's dashboard in the **Project description (optional)** field.
- - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
+ - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
change the **Visibility Level**.
1. Select **Create project**.
@@ -147,7 +147,7 @@ Custom project templates are available at:
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13756) in GitLab 12.10
-The HIPAA Audit Protocol template contains issues for audit inquiries in the
+The HIPAA Audit Protocol template contains issues for audit inquiries in the
HIPAA Audit Protocol published by the U.S Department of Health and Human Services.
To create a project from the HIPAA Audit Protocol template:
@@ -160,14 +160,14 @@ To create a project from the HIPAA Audit Protocol template:
- To view a preview of the template, select **Preview**.
- To use the template for the project, select **Use template**.
1. Enter the project details:
- - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
- underscores, and emoji. You cannot use special characters. After you enter the name,
+ - In the **Project name** field, enter the name of your project. You can use spaces, hyphens,
+ underscores, and emoji. You cannot use special characters. After you enter the name,
the **Project slug** populates.
- - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
- slug as the URL path to the project. To change the slug, first enter the project name,
- then change the slug.
+ - In the **Project slug** field, enter the path to your project. The GitLab instance uses the
+ slug as the URL path to the project. To change the slug, first enter the project name,
+ then change the slug.
- In the **Project description (optional)** field, enter the description of your project's dashboard.
- - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
+ - To modify the project's [viewing and access rights](../../public_access/public_access.md) for users,
change the **Visibility Level**.
1. Select **Create project**.
@@ -175,16 +175,16 @@ To create a project from the HIPAA Audit Protocol template:
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/26388) in GitLab 10.5.
-Use `git push` to push a local project repository to GitLab. After you push a repository,
+Use `git push` to push a local project repository to GitLab. After you push a repository,
GitLab creates your project in your chosen namespace.
You cannot use `git push` to create projects with project paths that:
- Have previously been used.
-- Have been [renamed](settings/index.md#renaming-a-repository).
+- Have been [renamed](settings/index.md#renaming-a-repository).
-Previously used project paths have a redirect. The redirect causes push attempts to redirect requests
-to the renamed project location, instead of creating a new project. To create a new project for a previously
+Previously used project paths have a redirect. The redirect causes push attempts to redirect requests
+to the renamed project location, instead of creating a new project. To create a new project for a previously
used or renamed project, use the [UI](#create-a-project) or the [Projects API](../../api/projects.md#create-project).
Prerequisites:
@@ -196,20 +196,20 @@ Prerequisites:
1. On the top bar, select **Menu > Project**.
1. Select **Groups**.
1. Select a group.
- 1. Confirm that **New project** is visible in the upper right
- corner. Contact your GitLab
+ 1. Confirm that **New project** is visible in the upper right
+ corner. Contact your GitLab
administrator if you require permission.
To push your repository and create a project:
1. Push with SSH or HTTPS:
- - To push with SSH:
+ - To push with SSH:
```shell
git push --set-upstream git@gitlab.example.com:namespace/myproject.git master
```
- - To push with HTTPS:
+ - To push with HTTPS:
```shell
git push --set-upstream https://gitlab.example.com/namespace/myproject.git master
@@ -220,7 +220,7 @@ To push your repository and create a project:
- For `myproject`, use the name of your project.
- Optional. To export existing repository tags, append the `--tags` flag to your `git push` command.
1. Optional. To configure the remote:
-
+
```shell
git remote add origin https://gitlab.example.com/namespace/myproject.git
```
@@ -232,7 +232,7 @@ remote: The private project namespace/myproject was created.
```
To view your new project, go to `https://gitlab.example.com/namespace/myproject`.
-Your project's visibility is set to **Private** by default. To change project visibility, adjust your
+Your project's visibility is set to **Private** by default. To change project visibility, adjust your
[project's settings](../../public_access/public_access.md#change-project-visibility).
## Star a project
@@ -260,8 +260,8 @@ To add a star to a project:
## Delete a project
-After you delete a project, projects in personal namespaces are deleted immediately. You can
-[enable delayed project removal](../group/index.md#enable-delayed-project-deletion) to
+After you delete a project, projects in personal namespaces are deleted immediately. You can
+[enable delayed project removal](../group/index.md#enable-delayed-project-deletion) to
delay deletion of projects in a group.
To delete a project:
@@ -295,8 +295,8 @@ To leave a project:
1. On the top bar, select **Menu > Project**.
1. Select **Your projects** or **Explore projects**.
1. Select a project.
-1. Select **Leave project**. The **Leave project** option only displays
-on the project dashboard when a project is part of a group under a
+1. Select **Leave project**. The **Leave project** option only displays
+on the project dashboard when a project is part of a group under a
[group namespace](../group/index.md#namespaces).
## Use your project as a Go package