diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-07 15:09:52 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-07 15:09:52 +0000 |
commit | e43077ab4742ba5083a01a1e5341db1a1b7a1701 (patch) | |
tree | c33a00fb176caff735243c484bbd594a3b08bb6e /doc | |
parent | 211a8c3361ccf4eb92f36edbdcf15c98fcdcc8b7 (diff) | |
download | gitlab-ce-e43077ab4742ba5083a01a1e5341db1a1b7a1701.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/monitoring/gitlab_self_monitoring_project/index.md | 7 | ||||
-rw-r--r-- | doc/administration/user_settings.md | 2 | ||||
-rw-r--r-- | doc/api/members.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/structure.md | 2 | ||||
-rw-r--r-- | doc/development/shell_commands.md | 2 | ||||
-rw-r--r-- | doc/development/testing_guide/best_practices.md | 18 | ||||
-rw-r--r-- | doc/user/project/clusters/kubernetes_pod_logs.md | 2 | ||||
-rw-r--r-- | doc/user/project/code_owners.md | 3 |
8 files changed, 33 insertions, 5 deletions
diff --git a/doc/administration/monitoring/gitlab_self_monitoring_project/index.md b/doc/administration/monitoring/gitlab_self_monitoring_project/index.md index df109b94d2d..edd263428cb 100644 --- a/doc/administration/monitoring/gitlab_self_monitoring_project/index.md +++ b/doc/administration/monitoring/gitlab_self_monitoring_project/index.md @@ -48,3 +48,10 @@ to the Prometheus config in order for GitLab to receive notifications of any ale Once the webhook is setup, you can [take action on incoming alerts](../../../user/project/integrations/prometheus.md#taking-action-on-incidents-ultimate). + +## Adding custom metrics to the self monitoring project + +You can add custom metrics in the self monitoring project by: + +1. [Duplicating](../../../user/project/integrations/prometheus.md#duplicating-a-gitlab-defined-dashboard) the default dashboard. +1. [Editing](../../../user/project/integrations/prometheus.md#view-and-edit-the-source-file-of-a-custom-dashboard) the newly created dashboard file and configuring it with [dashboard YAML properties](../../../user/project/integrations/prometheus.md#dashboard-yaml-properties). diff --git a/doc/administration/user_settings.md b/doc/administration/user_settings.md index f9654655949..7a3e1d86712 100644 --- a/doc/administration/user_settings.md +++ b/doc/administration/user_settings.md @@ -31,5 +31,5 @@ gitlab_rails['gitlab_username_changing_enabled'] = false For source installations, uncomment the following line in `config/gitlab.yml`: ```yaml -# username_changing_enabled: false # default: true - User can change her username/namespace +# username_changing_enabled: false # default: true - User can change their username/namespace ``` diff --git a/doc/api/members.md b/doc/api/members.md index 3b424c2deff..ed6fb60f86c 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -64,7 +64,7 @@ Example response: Gets a list of group or project members viewable by the authenticated user, including inherited members through ancestor groups. When a user is a member of the project/group and of one or more ancestor groups the user is returned only once with the project `access_level` (if exists) -or the `access_level` for the user in the first group which he belongs to in the project groups ancestors chain. +or the `access_level` for the user in the first group which they belong to in the project groups ancestors chain. ``` GET /groups/:id/members/all diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index ac834ef1aac..1bb3dd3521b 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -96,8 +96,10 @@ Link each one to an appropriate place for more information. This is the part of the document where you can include one or more sets of instructions, each to accomplish a specific task. Headers should describe the task the reader will achieve by following the instructions within, typically starting with a verb. Larger instruction sets may have subsections covering specific phases of the process. +Where appropriate, provide examples of code or configuration files to better clarify intended usage. - Write a step-by-step guide, with no gaps between the steps. +- Include example code or configurations as part of the relevant step. Use appropriate markdown to [wrap code blocks with syntax highlighting](../../user/markdown.html#colored-code-and-syntax-highlighting). - Start with an h2 (`##`), break complex steps into small steps using subheadings h3 > h4 > h5 > h6. _Never skip a hierarchy level, such as h2 > h4_, as it will break the TOC and may affect the breadcrumbs. diff --git a/doc/development/shell_commands.md b/doc/development/shell_commands.md index 1f97d433223..7079f7a9914 100644 --- a/doc/development/shell_commands.md +++ b/doc/development/shell_commands.md @@ -168,7 +168,7 @@ user_input = '../other-repo.git/other-file' repo_path = 'repositories/user-repo.git' # The intention of the code below is to open a file under repo_path, but -# because the user used '..' she can 'break out' into +# because the user used '..' they can 'break out' into # 'repositories/other-repo.git' full_path = File.join(repo_path, user_input) File.open(full_path) do # Oops! diff --git a/doc/development/testing_guide/best_practices.md b/doc/development/testing_guide/best_practices.md index 84dcba03e31..54666d67b8d 100644 --- a/doc/development/testing_guide/best_practices.md +++ b/doc/development/testing_guide/best_practices.md @@ -72,6 +72,24 @@ When using spring and guard together, use `SPRING=1 bundle exec guard` instead t - Use [`:aggregate_failures`](https://relishapp.com/rspec/rspec-core/docs/expectation-framework-integration/aggregating-failures) when there is more than one expectation in a test. - For [empty test description blocks](https://github.com/rubocop-hq/rspec-style-guide#it-and-specify), use `specify` rather than `it do` if the test is self-explanatory. +### Coverage + +[`simplecov`](https://github.com/colszowka/simplecov) is used to generate code test coverage reports. +These are generated automatically on the CI, but not when running tests locally. To generate partial reports +when you run a spec file on your machine, set the `SIMPLECOV` environment variable: + +```shell +SIMPLECOV=1 bundle exec rspec spec/models/repository_spec.rb +``` + +Coverage reports are generated into the `coverage` folder in the app root, and you can open these in your browser, for example: + +```shell +firefox coverage/index.html +``` + +Use the coverage reports to ensure your tests cover 100% of your code. + ### System / Feature tests NOTE: **Note:** Before writing a new system test, [please consider **not** diff --git a/doc/user/project/clusters/kubernetes_pod_logs.md b/doc/user/project/clusters/kubernetes_pod_logs.md index ac24352dbda..e83f0957c02 100644 --- a/doc/user/project/clusters/kubernetes_pod_logs.md +++ b/doc/user/project/clusters/kubernetes_pod_logs.md @@ -57,7 +57,7 @@ Support for historical data is coming [in a future release](https://gitlab.com/g ### Full text search -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21656) in GitLab 12.8. When you enable [Elastic Stack](../../clusters/applications.md#elastic-stack) on your cluster, you can search the content of your logs via a search bar. diff --git a/doc/user/project/code_owners.md b/doc/user/project/code_owners.md index 00fd524865b..a81c0beb6d0 100644 --- a/doc/user/project/code_owners.md +++ b/doc/user/project/code_owners.md @@ -45,7 +45,8 @@ Once set, Code Owners are displayed in merge requests widgets: Files can be specified using the same kind of patterns you would use in the `.gitignore` file followed by the `@username` or email of one or more users or by the `@name` of one or more groups that should -be owners of the file. +be owners of the file. Groups must be added as [members of the project](members/index.md), +or they will be ignored. The order in which the paths are defined is significant: the last pattern that matches a given path will be used to find the code |