Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-07-05 06:08:33 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-07-05 06:08:33 +0300
commitf49266f20bb48bb659ec02f24100114f844f614f (patch)
treef5a80ae2a7e33487ad27b6d9d31fa0ba075e210f /doc
parent2e74e7299b20e0c3d0c5c26e329ef26388abb9ca (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/audit_event_streaming.md2
-rw-r--r--doc/administration/feature_flags.md4
-rw-r--r--doc/api/metadata.md2
-rw-r--r--doc/development/adding_database_indexes.md7
-rw-r--r--doc/development/fe_guide/vue.md2
-rw-r--r--doc/development/migration_style_guide.md6
-rw-r--r--doc/development/pipelines.md2
-rw-r--r--doc/development/testing_guide/contract/consumer_tests.md4
-rw-r--r--doc/development/testing_guide/contract/provider_tests.md12
-rw-r--r--doc/development/testing_guide/end_to_end/best_practices.md2
-rw-r--r--doc/user/admin_area/moderate_users.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/project/releases/index.md2
14 files changed, 32 insertions, 19 deletions
diff --git a/doc/administration/audit_event_streaming.md b/doc/administration/audit_event_streaming.md
index dfdb5c5e169..73881b5d6bd 100644
--- a/doc/administration/audit_event_streaming.md
+++ b/doc/administration/audit_event_streaming.md
@@ -246,7 +246,7 @@ query {
nodes {
destinationUrl
id
- headers {
+ headers {
nodes {
key
value
diff --git a/doc/administration/feature_flags.md b/doc/administration/feature_flags.md
index 5257b527827..77f7f621a07 100644
--- a/doc/administration/feature_flags.md
+++ b/doc/administration/feature_flags.md
@@ -123,11 +123,11 @@ For example, to enable the [`:product_analytics`](../operations/product_analytic
Feature.enable(:product_analytics, Project.find(1234))
```
-`Feature.enable` and `Feature.disable` always return `nil`, this is not an indication that the command failed:
+`Feature.enable` and `Feature.disable` always return `true`, even if the application doesn't use the flag:
```ruby
irb(main):001:0> Feature.enable(:my_awesome_feature)
-=> nil
+=> true
```
When the feature is ready, GitLab removes the feature flag, and the option for
diff --git a/doc/api/metadata.md b/doc/api/metadata.md
index efce623d72c..70c29ef5748 100644
--- a/doc/api/metadata.md
+++ b/doc/api/metadata.md
@@ -39,7 +39,7 @@ Example response:
"revision": "c401a659d0c",
"kas": {
"enabled": true,
- "externalUrl": "grpc://gitlab.example.com:8150",
+ "externalUrl": "grpc://gitlab.example.com:8150",
"version": "15.0.0"
}
}
diff --git a/doc/development/adding_database_indexes.md b/doc/development/adding_database_indexes.md
index 050153963a9..2e91d45181e 100644
--- a/doc/development/adding_database_indexes.md
+++ b/doc/development/adding_database_indexes.md
@@ -107,6 +107,13 @@ determining whether existing indexes are still required. More information on
the meaning of the various columns can be found at
<https://www.postgresql.org/docs/current/monitoring-stats.html>.
+To determine if an index is still being used on production, use the following
+Thanos query with your index name:
+
+```sql
+sum(rate(pg_stat_user_indexes_idx_tup_read{env="gprd", indexrelname="index_ci_name", type="patroni-ci"}[5m]))
+```
+
Because the query output relies on the actual usage of your database, it
may be affected by factors such as:
diff --git a/doc/development/fe_guide/vue.md b/doc/development/fe_guide/vue.md
index e9460ca31b3..4372e9203a1 100644
--- a/doc/development/fe_guide/vue.md
+++ b/doc/development/fe_guide/vue.md
@@ -483,7 +483,7 @@ const useSomeLogic = () => {
```
```javascript
-const done = () => emit('done');
+const done = () => emit('done');
const useSomeLogic = (done) => {
doSomeLogic();
diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md
index 4a1d4389ceb..e0e21319f47 100644
--- a/doc/development/migration_style_guide.md
+++ b/doc/development/migration_style_guide.md
@@ -577,6 +577,12 @@ class MyMigration < Gitlab::Database::Migration[2.0]
end
```
+Verify the index is not being used anymore with this Thanos query:
+
+```sql
+sum(rate(pg_stat_user_indexes_idx_tup_read{env="gprd", indexrelname="index_ci_name", type="patroni-ci"}[5m]))
+```
+
Note that it is not necessary to check if the index exists prior to
removing it, however it is required to specify the name of the
index that is being removed. This can be done either by passing the name
diff --git a/doc/development/pipelines.md b/doc/development/pipelines.md
index d4395cc4e4b..e222997df31 100644
--- a/doc/development/pipelines.md
+++ b/doc/development/pipelines.md
@@ -37,7 +37,7 @@ flowchart LR
subgraph backend
be["Backend code"]--tested with-->rspec
end
-
+
be--generates-->fixtures["frontend fixtures"]
fixtures--used in-->jest
```
diff --git a/doc/development/testing_guide/contract/consumer_tests.md b/doc/development/testing_guide/contract/consumer_tests.md
index ad047a9b301..df7c9ee0abd 100644
--- a/doc/development/testing_guide/contract/consumer_tests.md
+++ b/doc/development/testing_guide/contract/consumer_tests.md
@@ -67,11 +67,11 @@ pactWith(
(provider) => {
describe('Merge Request Discussions Endpoint', () => {
beforeEach(() => {
-
+
});
it('return a successful body', () => {
-
+
});
});
},
diff --git a/doc/development/testing_guide/contract/provider_tests.md b/doc/development/testing_guide/contract/provider_tests.md
index dba951ac651..92ac4c4ed71 100644
--- a/doc/development/testing_guide/contract/provider_tests.md
+++ b/doc/development/testing_guide/contract/provider_tests.md
@@ -24,7 +24,7 @@ require_relative '../../../spec_helper'
module Provider
module DiscussionsHelper
Pact.service_provider 'Merge Request Discussions Endpoint' do
-
+
end
end
end
@@ -41,7 +41,7 @@ module Provider
module DiscussionsHelper
Pact.service_provider 'Merge Request Discussions Endpoint' do
honours_pact_with 'MergeRequest#show' do
-
+
end
end
end
@@ -61,9 +61,9 @@ module Provider
module DiscussionsHelper
Pact.service_provider 'Merge Request Discussions Endpoint' do
app { Environment::Test.app }
-
+
honours_pact_with 'MergeRequest#show' do
-
+
end
end
end
@@ -81,7 +81,7 @@ module Provider
module DiscussionsHelper
Pact.service_provider 'Merge Request Discussions Endpoint' do
app { Environment::Test.app }
-
+
honours_pact_with 'MergeRequest#show' do
pact_uri '../contracts/project/merge_request/show/mergerequest#show-merge_request_discussions_endpoint.json'
end
@@ -152,7 +152,7 @@ In the `provider_states_for` block, you then define the state the test data is f
```ruby
Pact.provider_states_for "MergeRequest#show" do
provider_state "a merge request with discussions exists" do
-
+
end
end
```
diff --git a/doc/development/testing_guide/end_to_end/best_practices.md b/doc/development/testing_guide/end_to_end/best_practices.md
index 85f8beeacad..00b843ffdbe 100644
--- a/doc/development/testing_guide/end_to_end/best_practices.md
+++ b/doc/development/testing_guide/end_to_end/best_practices.md
@@ -220,7 +220,7 @@ For example, if you encapsulate some actions and expectations in a private metho
it "has Owner role with Owner permissions" do
Page::Dashboard::Projects.perform do |projects|
projects.filter_by_name(project.name)
-
+
expect(projects).to have_project_with_access_role(project.name, 'Owner')
end
diff --git a/doc/user/admin_area/moderate_users.md b/doc/user/admin_area/moderate_users.md
index dc6ff96c31f..ab581cd3aa8 100644
--- a/doc/user/admin_area/moderate_users.md
+++ b/doc/user/admin_area/moderate_users.md
@@ -265,7 +265,7 @@ Use the Admin Area to delete users.
1. Select **Delete user**.
NOTE:
-You can only delete a user if there are inherited or direct owners of a group. You cannot delete a user if they are the only group owner.
+You can only delete a user if there are inherited or direct owners of a group. You cannot delete a user if they are the only group owner.
You can also delete a user and their contributions, such as merge requests, issues, and groups of which they are the only group owner.
diff --git a/doc/user/application_security/api_fuzzing/index.md b/doc/user/application_security/api_fuzzing/index.md
index 1261155a609..342e076068e 100644
--- a/doc/user/application_security/api_fuzzing/index.md
+++ b/doc/user/application_security/api_fuzzing/index.md
@@ -928,7 +928,7 @@ logging.basicConfig(filename=log_file_path, level=logging.DEBUG)
def get_auth_response():
authorization_url = 'https://authorization.service/api/get_api_token'
return requests.get(
- f'{authorization_url}',
+ f'{authorization_url}',
auth=(os.environ.get('AUTH_USER'), os.environ.get('AUTH_PWD'))
)
diff --git a/doc/user/application_security/dast_api/index.md b/doc/user/application_security/dast_api/index.md
index c20625fd1de..fdca02267e4 100644
--- a/doc/user/application_security/dast_api/index.md
+++ b/doc/user/application_security/dast_api/index.md
@@ -877,7 +877,7 @@ logging.basicConfig(filename=log_file_path, level=logging.DEBUG)
def get_auth_response():
authorization_url = 'https://authorization.service/api/get_api_token'
return requests.get(
- f'{authorization_url}',
+ f'{authorization_url}',
auth=(os.environ.get('AUTH_USER'), os.environ.get('AUTH_PWD'))
)
diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md
index d5ddc0468e1..9c22009feb4 100644
--- a/doc/user/project/releases/index.md
+++ b/doc/user/project/releases/index.md
@@ -210,7 +210,7 @@ In the second workflow, the `release` job runs in multiple pipelines. To prevent
```yaml
release_job:
rules:
- - if: $CI_COMMIT_TAG
+ - if: $CI_COMMIT_TAG
when: never # Do not run this job in a tag pipeline
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH # Run this job when commits are pushed or merged to the default branch
script: