diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-26 00:09:20 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-26 00:09:20 +0300 |
commit | 7625bc732c8b330989913fd933e6e94ecd4a1957 (patch) | |
tree | 6142552413072c5eeecbeaef2107d5c469a203bc /doc | |
parent | 0351d9ed83635ce3258e2d09ba92b46a7cdcfa61 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/geo/replication/troubleshooting.md | 6 | ||||
-rw-r--r-- | doc/administration/operations/rails_console.md | 3 | ||||
-rw-r--r-- | doc/api/deploy_tokens.md | 2 | ||||
-rw-r--r-- | doc/development/ee_features.md | 2 | ||||
-rw-r--r-- | doc/user/group/manage.md | 6 | ||||
-rw-r--r-- | doc/user/packages/terraform_module_registry/index.md | 8 | ||||
-rw-r--r-- | doc/user/project/integrations/slack.md | 3 | ||||
-rw-r--r-- | doc/user/project/repository/mirror/index.md | 3 | ||||
-rw-r--r-- | doc/user/project/repository/push_rules.md | 3 | ||||
-rw-r--r-- | doc/user/project/working_with_projects.md | 9 |
10 files changed, 31 insertions, 14 deletions
diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md index effc49d21ba..0931a551b23 100644 --- a/doc/administration/geo/replication/troubleshooting.md +++ b/doc/administration/geo/replication/troubleshooting.md @@ -317,7 +317,8 @@ sudo gitlab-rake gitlab:geo:check to gather the following, basic troubleshooting information. WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. #### Get the number of verification failed repositories @@ -854,7 +855,8 @@ therefore short-circuited. `last_sync_failure` is now set to `The file is missin examples, but things generally work the same for the other types. WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. #### The Replicator diff --git a/doc/administration/operations/rails_console.md b/doc/administration/operations/rails_console.md index 70386cbbb94..f818d2d1a3c 100644 --- a/doc/administration/operations/rails_console.md +++ b/doc/administration/operations/rails_console.md @@ -736,7 +736,8 @@ ApplicationSetting.current ### Open object in `irb` WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. Sometimes it is easier to go through a method if you are in the context of the object. You can shim into the namespace of `Object` to let you open `irb` in the context of any object: diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index 5c4c99f3ba3..dff3ef05bb0 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -222,7 +222,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:-----------------------|:------------| -| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the project](index.md#namespaced-path-encoding). | +| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the group](index.md#namespaced-path-encoding). | | `active` | boolean | **{dotted-circle}** No | Limit by active status. | Example request: diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index 2516196d2e0..24d4aeeb87e 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -130,7 +130,7 @@ export GITLAB_SIMULATE_SAAS=1 There are many ways to pass an environment variable to your local GitLab instance. For example, you can create a `env.runit` file in the root of your GDK with the above snippet. -#### Allow use of licensed EE feature +#### Enable plans per namespace To enable plans per namespace turn on the `Allow use of licensed EE features` option from the settings page. This will make licensed EE features available to projects only if the project namespace's plan includes the feature diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md index a7f87404732..19620890253 100644 --- a/doc/user/group/manage.md +++ b/doc/user/group/manage.md @@ -816,7 +816,8 @@ Group.find_by_sql("SELECT * FROM namespaces WHERE name LIKE '%oup'") If transferring a group doesn't work through the UI or API, you may want to attempt the transfer in a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session): WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby user = User.find_by_username('<username>') @@ -847,7 +848,8 @@ At times, a group deletion may get stuck. If needed, in a [Rails console session you can attempt to delete a group using the following command: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby GroupDestroyWorker.new.perform(group_id, user_id) diff --git a/doc/user/packages/terraform_module_registry/index.md b/doc/user/packages/terraform_module_registry/index.md index 52ca5983083..2b99ff807ec 100644 --- a/doc/user/packages/terraform_module_registry/index.md +++ b/doc/user/packages/terraform_module_registry/index.md @@ -24,9 +24,11 @@ When you publish a Terraform Module, if it does not exist, it is created. Prerequisites: -- A package with the same name and version must not already exist in the top-level namespace. +- The package name and version [must be unique in the top-level namespace](../infrastructure_registry/index.md#how-module-resolution-works). - Your project and group names must not include a dot (`.`). For example, `source = "gitlab.example.com/my.group/project.name"`. - You must [authenticate with the API](../../../api/index.md#authentication). If authenticating with a deploy token, it must be configured with the `write_package_registry` scope. +- The name of a module [must be unique within the scope of its group](../infrastructure_registry/index.md#how-module-resolution-works), otherwise an + [error occurs](#troubleshooting). ```plaintext PUT /projects/:id/packages/terraform/modules/:module-name/:module-system/:module-version/file @@ -141,3 +143,7 @@ For examples of the Terraform module registry, check the projects below: - The [_GitLab local file_ project](https://gitlab.com/mattkasa/gitlab-local-file) creates a minimal Terraform module and uploads it into the Terraform module registry using GitLab CI/CD. - The [_Terraform module test_ project](https://gitlab.com/mattkasa/terraform-module-test) uses the module from the previous example. + +## Troubleshooting + +- Publishing a module with a duplicate name results in a `{"message":"Access Denied"}` error. There's an ongoing discussion about allowing duplicate module names [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/368040). diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 4911df54c19..a1bff1ea920 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -134,7 +134,8 @@ To disable notifications for all projects that have Slack integration enabled, [start a rails console session](../../../administration/operations/rails_console.md#starting-a-rails-console-session) and use a script similar to the following: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby # Grab all projects that have the Slack notifications enabled diff --git a/doc/user/project/repository/mirror/index.md b/doc/user/project/repository/mirror/index.md index b0ac6277b8b..4ce162ac95e 100644 --- a/doc/user/project/repository/mirror/index.md +++ b/doc/user/project/repository/mirror/index.md @@ -326,7 +326,8 @@ repository mirroring, mirroring breaks when people leave the company. Use this script to migrate disparate mirroring users and tokens into a single service account: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby svc_user = User.find_by(username: 'ourServiceUser') diff --git a/doc/user/project/repository/push_rules.md b/doc/user/project/repository/push_rules.md index 917fca03967..d7ceb0ae131 100644 --- a/doc/user/project/repository/push_rules.md +++ b/doc/user/project/repository/push_rules.md @@ -304,7 +304,8 @@ For example, to enable **Check whether the commit author is a GitLab user** and and create a filter for allowing commits from a specific email domain only through rails console: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ``` ruby Project.find_each do |p| diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 705e49df039..709bc63e72b 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -516,7 +516,8 @@ If a project or repository has been updated but the state is not reflected in th You can do so through [a Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session) and one of the following: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby ## Clear project cache @@ -545,7 +546,8 @@ end If a project cannot be deleted, you can attempt to delete it through [Rails console](../../administration/operations/rails_console.md#starting-a-rails-console-session). WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby project = Project.find_by_full_path('<project_path>') @@ -569,7 +571,8 @@ To toggle a specific feature, you can [start a Rails console session](../../admi and run the following function: WARNING: -Any command that changes data directly could be damaging if not run correctly, or under the right conditions. We highly recommend running them in a test environment with a backup of the instance ready to be restored, just in case. + +Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore. ```ruby projects = Group.find_by_name('_group_name').projects |