diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-01 09:07:45 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-01 09:07:45 +0000 |
commit | b11f7057d067885619ee3e513751f180b2e8ad85 (patch) | |
tree | dfb3077ea8716ed217f5ce4324be4e25a450c599 /doc | |
parent | e50050a8756a20b6aa118edbad3369674e4c63ba (diff) | |
download | gitlab-ce-b11f7057d067885619ee3e513751f180b2e8ad85.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/projects.md | 42 | ||||
-rw-r--r-- | doc/ci/git_submodules.md | 2 | ||||
-rw-r--r-- | doc/ci/junit_test_reports.md | 2 | ||||
-rw-r--r-- | doc/ci/multi_project_pipelines.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 6 | ||||
-rw-r--r-- | doc/integration/elasticsearch.md | 16 | ||||
-rw-r--r-- | doc/topics/autodevops/index.md | 4 | ||||
-rw-r--r-- | doc/user/discussions/index.md | 4 | ||||
-rw-r--r-- | doc/user/project/canary_deployments.md | 2 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 2 |
10 files changed, 42 insertions, 40 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 04775b0339d..952d39af8f4 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -41,26 +41,28 @@ GET /projects | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `archived` | boolean | no | Limit by archived status | -| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` | -| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` | -| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` | -| `search` | string | no | Return list of projects matching the search criteria | -| `search_namespaces` | boolean | no | Include ancestor namespaces when matching search criteria. Default is `false` | -| `simple` | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. | -| `owned` | boolean | no | Limit by projects explicitly owned by the current user | -| `membership` | boolean | no | Limit by projects that the current user is a member of | -| `starred` | boolean | no | Limit by projects starred by the current user | -| `statistics` | boolean | no | Include project statistics | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | -| `with_issues_enabled` | boolean | no | Limit by enabled issues feature | -| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature | -| `with_programming_language` | string | no | Limit by projects which use the given programming language | -| `wiki_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | -| `repository_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | -| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) | -| `id_after` | integer | no | Limit results to projects with IDs greater than the specified ID | -| `id_before` | integer | no | Limit results to projects with IDs less than the specified ID | +| `archived` | boolean | no | Limit by archived status | +| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` | +| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` | +| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` | +| `search` | string | no | Return list of projects matching the search criteria | +| `search_namespaces` | boolean | no | Include ancestor namespaces when matching search criteria. Default is `false` | +| `simple` | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. | +| `owned` | boolean | no | Limit by projects explicitly owned by the current user | +| `membership` | boolean | no | Limit by projects that the current user is a member of | +| `starred` | boolean | no | Limit by projects starred by the current user | +| `statistics` | boolean | no | Include project statistics | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `with_issues_enabled` | boolean | no | Limit by enabled issues feature | +| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature | +| `with_programming_language` | string | no | Limit by projects which use the given programming language | +| `wiki_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | +| `repository_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | +| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) | +| `id_after` | integer | no | Limit results to projects with IDs greater than the specified ID | +| `id_before` | integer | no | Limit results to projects with IDs less than the specified ID | +| `last_activity_after` | datetime | no | Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | +| `last_activity_before` | datetime | no | Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | NOTE: **Note:** This endpoint supports [keyset pagination](README.md#keyset-based-pagination) for selected `order_by` options. diff --git a/doc/ci/git_submodules.md b/doc/ci/git_submodules.md index 8807e1beab8..4797251129b 100644 --- a/doc/ci/git_submodules.md +++ b/doc/ci/git_submodules.md @@ -6,7 +6,7 @@ type: reference > **Notes:** > -> - GitLab 8.12 introduced a new [CI job permissions model][newperms] and you +> - GitLab 8.12 introduced a new [CI job permissions model](../user/project/new_ci_build_permissions_model.md) and you > are encouraged to upgrade your GitLab instance if you haven't done already. > If you are **not** using GitLab 8.12 or higher, you would need to work your way > around submodules in order to access the sources of e.g., `gitlab.com/group/project` diff --git a/doc/ci/junit_test_reports.md b/doc/ci/junit_test_reports.md index 90fd44bdf24..78c9965aa08 100644 --- a/doc/ci/junit_test_reports.md +++ b/doc/ci/junit_test_reports.md @@ -224,7 +224,7 @@ with failed showing at the top, skipped next and successful cases last. This feature comes with the `:junit_pipeline_view` feature flag disabled by default. This feature is disabled due to some performance issues with very large data sets. -When [the performance issue](https://gitlab.com/gitlab-org/gitlab/issues/37725) is resolved, the feature will be enabled by default. +When [the performance is improved](https://gitlab.com/groups/gitlab-org/-/epics/2854), the feature will be enabled by default. To enable this feature, ask a GitLab administrator with Rails console access to run the following command: diff --git a/doc/ci/multi_project_pipelines.md b/doc/ci/multi_project_pipelines.md index 09fb5e3a7b9..7c79bf350b9 100644 --- a/doc/ci/multi_project_pipelines.md +++ b/doc/ci/multi_project_pipelines.md @@ -51,7 +51,7 @@ and when hovering or tapping (on touchscreen devices) they will expand and be sh ## Triggering multi-project pipelines through API -> - Use of `CI_JOB_TOKEN` for multi-project pipelines was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2017) in [GitLab Premium][ee] 9.3. +> - Use of `CI_JOB_TOKEN` for multi-project pipelines was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2017) in [GitLab Premium](https://about.gitlab.com/pricing/) 9.3. > - Use of `CI_JOB_TOKEN` for multi-project pipelines was [made available](https://gitlab.com/gitlab-org/gitlab/issues/31573) in all tiers in GitLab 12.4. When you use the [`CI_JOB_TOKEN` to trigger pipelines](triggers/README.md#ci-job-token), GitLab diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 4f1c266a9bf..b231fa45f6d 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -362,7 +362,7 @@ Check specific punctuation rules for [lists](#lists) below. | Rule | Example | | ---- | ------- | | Always end full sentences with a period. | _For a complete overview, read through this document._| -| Always add a space after a period when beginning a new sentence | _For a complete overview, check this doc. For other references, check out this guide._ | +| Always add a space after a period when beginning a new sentence. | _For a complete overview, check this doc. For other references, check out this guide._ | | Do not use double spaces. | --- | | Do not use tabs for indentation. Use spaces instead. You can configure your code editor to output spaces instead of tabs when pressing the tab key. | --- | | Use serial commas ("Oxford commas") before the final 'and/or' in a list. | _You can create new issues, merge requests, and milestones._ | @@ -816,7 +816,7 @@ you have your MR reviewed and approved by a technical writer. 1. Copy the code below and paste it into your Markdown file. Leave a blank line above and below it. Do NOT edit the code - (don't remove or add any spaces, etc). + (don't remove or add any spaces). 1. On YouTube, visit the video URL you want to display. Copy the regular URL from your browser (`https://www.youtube.com/watch?v=VIDEO-ID`) and replace the video title and link in the line under `<div class="video-fallback">`. @@ -1000,7 +1000,7 @@ Whenever you need to call special attention to particular sentences, use the following markup for highlighting. _Note that the alert boxes only work for one paragraph only. Multiple paragraphs, -lists, headers, etc will not render correctly. For multiple lines, use blockquotes instead._ +lists, headers and so on, will not render correctly. For multiple lines, use blockquotes instead._ Alert boxes only render on the GitLab Docs site (<https://docs.gitlab.com>). Within GitLab itself, they will appear as plain Markdown text (like the examples diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md index 6314eaad35f..47497e7b385 100644 --- a/doc/integration/elasticsearch.md +++ b/doc/integration/elasticsearch.md @@ -427,14 +427,14 @@ There are several Rake tasks available to you via the command line: - [`sudo gitlab-rake gitlab:elastic:projects_not_indexed`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake) - Displays which projects are not indexed. - [`sudo gitlab-rake gitlab:elastic:reindex_to_another_cluster[<SOURCE_CLUSTER_URL>,<DESTINATION_CLUSTER_URL>]`](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/lib/tasks/gitlab/elastic.rake) - - Creates a new index in the destination cluster and triggers a [reindex from - remote](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html#reindex-from-remote) - such that the index is fully copied from the source index. This can be - useful when you wish to perform a migration to a new cluster as this - reindexing should be quicker than reindexing via GitLab. Note that remote - reindex requires your source cluster to be whitelisted in your destination - cluster in Elasticsearch settings as per [the - documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html#reindex-from-remote). + - Creates a new index in the destination cluster from the source index using + Elasticsearch "reindex from remote", where the source index is copied to the + destination. This is useful when migrating to a new cluster because it should be + quicker than reindexing via GitLab. + + NOTE: **Note:** + Your source cluster must be whitelisted in your destination cluster's Elasticsearch + settings. See [Reindex from remote](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html#reindex-from-remote). ### Environment Variables diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 5eb23326e43..bf58a2f7510 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -1036,8 +1036,8 @@ Then add any extra changes you want. Your additions will be merged with the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) using the behaviour described for [`include`](../../ci/yaml/README.md#include). -It is also possible to copy and paste the contents of the [Auto DevOps -template] into your project and edit this as needed. You may prefer to do it +It is also possible to copy and paste the contents of the [Auto DevOps template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) +into your project and edit this as needed. You may prefer to do it that way if you want to specifically remove any part of it. ### Customizing the Kubernetes namespace diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index 4b443db7b54..9f24807ddf4 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -20,7 +20,7 @@ comment at any time, and anyone with [Maintainer access level](../permissions.md higher can also edit a comment made by someone else. You can also reply to a comment notification email to reply to the comment if -[Reply by email] is configured for your GitLab instance. Replying to a standard comment +[Reply by email](../../administration/reply_by_email.md) is configured for your GitLab instance. Replying to a standard comment creates another standard comment. Replying to a threaded comment creates a reply in the thread. Email replies support [Markdown](../markdown.md) and [quick actions](../project/quick_actions.md), just as if you replied from the web. @@ -140,7 +140,7 @@ You can now proceed to merge the merge request from the UI. ### Moving a single thread to a new issue -> [Introduced][ce-8266] in GitLab 9.1 +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8266) in GitLab 9.1 To create a new issue for a single thread, you can use the **Resolve this thread in a new issue** button. diff --git a/doc/user/project/canary_deployments.md b/doc/user/project/canary_deployments.md index 26cf58654f2..f12a281584f 100644 --- a/doc/user/project/canary_deployments.md +++ b/doc/user/project/canary_deployments.md @@ -35,7 +35,7 @@ to be careful when using canaries with user-facing changes, because by default, requests from the same user will be randomly distributed between canary and non-canary pods, which could result in confusion or even errors. If needed, you may want to consider [setting `service.spec.sessionAffinity` to `ClientIP` in -your Kubernetes service definitions][kube-net](https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies), but that is beyond the scope of +your Kubernetes service definitions](https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies), but that is beyond the scope of this document. ## Enabling Canary Deployments diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index b961478ea6d..7968f5d1463 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -459,7 +459,7 @@ Note the following properties: | Property | Type | Required | Description | | ------ | ------ | ------ | ------ | | `type` | string | yes | Type of panel to be rendered. For bar chart types, set to `bar` | -| `query_range` | yes | yes | For bar chart, you must use a [range query] +| `query_range` | yes | yes | For bar chart, you must use a [range query](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries) ![bar chart panel type](img/prometheus_dashboard_bar_chart_panel_type_v12.10.png) |