diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/gitaly/praefect.md | 6 | ||||
-rw-r--r-- | doc/api/merge_requests.md | 10 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 47 | ||||
-rw-r--r-- | doc/development/pipelines.md | 6 | ||||
-rw-r--r-- | doc/subscriptions/index.md | 5 | ||||
-rw-r--r-- | doc/user/application_security/container_scanning/index.md | 2 | ||||
-rw-r--r-- | doc/user/group/roadmap/index.md | 17 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 9 |
8 files changed, 73 insertions, 29 deletions
diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index b010a6425c8..a34c6c0b336 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -541,6 +541,12 @@ Particular attention should be shown to: gitlab-ctl reconfigure ``` +1. Verify each `gitlab-shell` on each Gitaly instance can reach GitLab. On each Gitaly instance run: + + ```shell + /opt/gitlab/embedded/service/gitlab-shell/bin/check -config /opt/gitlab/embedded/service/gitlab-shell/config.yml + ``` + 1. Verify that GitLab can reach Praefect: ```shell diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 881fc27feec..454d4a2b35b 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -30,6 +30,7 @@ GET /merge_requests?state=all GET /merge_requests?milestone=release GET /merge_requests?labels=bug,reproduced GET /merge_requests?author_id=5 +GET /merge_requests?author_username=gitlab-bot GET /merge_requests?my_reaction_emoji=star GET /merge_requests?scope=assigned_to_me GET /merge_requests?search=foo&in=title @@ -51,7 +52,8 @@ Parameters: | `updated_after` | datetime | no | Return merge requests updated on or after the given time | | `updated_before` | datetime | no | Return merge requests updated on or before the given time | | `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead. | -| `author_id` | integer | no | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me` | +| `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me` +| `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced][ce-13060] in GitLab 12.10)_ | | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. | | `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | | `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | @@ -230,7 +232,8 @@ Parameters: | `updated_after` | datetime | no | Return merge requests updated on or after the given time | | `updated_before` | datetime | no | Return merge requests updated on or before the given time | | `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13060] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | -| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ | +| `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. _([Introduced][ce-13060] in GitLab 9.5)_ +| `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced][ce-13060] in GitLab 12.10)_ | | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ | | `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | | `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | @@ -392,7 +395,8 @@ Parameters: | `updated_after` | datetime | no | Return merge requests updated on or after the given time | | `updated_before` | datetime | no | Return merge requests updated on or before the given time | | `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> | -| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ | +| `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. _([Introduced][ce-13060] in GitLab 9.5)_ +| `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced][ce-13060] in GitLab 12.10)_ | | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced][ce-13060] in GitLab 9.5)_ | | `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | | `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index b231fa45f6d..940c660dc35 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -243,12 +243,35 @@ Do not include the same information in multiple places. [Link to a SSOT instead. ## Language -- Use inclusive language and avoid jargon, as well as uncommon - words. The docs should be clear and easy to understand. -- Do not write in the first person singular. Instead of "I" or "me," use "we," "you," "us," or "one." -- Be clear, concise, and stick to the goal of the doc. +GitLab documentation should be clear and easy to understand. + +- Be clear, concise, and stick to the goal of the documentation. - Write in US English with US grammar. +- Use inclusive language. +- Avoid jargon. +- Avoid uncommon words. +- Don't write in the first person singular. + - Instead of "I" or "me," use "we," "you," "us," or "one." + +### Point of view + +In most cases, it’s appropriate to use the second-person (you, yours) point of view, +because it’s friendly and easy to understand. + +<!-- How do we harmonize the second person in Pajamas with our first person plural in our doc guide? --> + +### Capitalization + - Capitalize "G" and "L" in GitLab. +- Use sentence case for: + - Titles. + - Labels. + - Menu items. + - Buttons. + - Headings. Don't capitalize other words in the title, unless + it refers to a product feature. For example: + - Capitalizing "issues" is acceptable in + `## What you can do with GitLab Issues`, but not in `## Closing multiple issues`. - Use title case when referring to: - [GitLab Features](https://about.gitlab.com/features/). For example, Issue Board, Geo, and Runner. @@ -335,8 +358,6 @@ as even native users of English might misunderstand them. - [Write in Markdown](#markdown). - Splitting long lines (preferably up to 100 characters) can make it easier to provide feedback on small chunks of text. - Insert an empty line for new paragraphs. -- Add a new line by ending a line with two spaces. [Using a backslash](../../user/markdown.md#newlines) doesn't work in the docs site. -- Use sentence case for titles, headings, labels, menu items, and buttons. - Insert an empty line between different markups (for example, after every paragraph, header, list, and so on). Example: ```md @@ -572,13 +593,10 @@ For other punctuation rules, please refer to the - Leave exactly one blank line before and after a heading. - Do not use links in headings. - Add the corresponding [product badge](#product-badges) according to the tier the feature belongs. -- Use sentence case in headings. Do not capitalize the words of the title, unless - it refers to a product feature. For example, capitalizing "issues" is acceptable in - `## What you can do with GitLab Issues`, but not in `## Closing multiple issues`. -- Our docs site search engine prioritizes headings, therefore, make sure to write - headings that contextualize the subject and help to take the user to the right - document. For example, `## Examples` is a bad heading; `## GitLab Pages examples` - is a better one. It's not an exact science, but please consider this carefully. +- Our docs site search engine prioritizes words used in headings and subheadings. + Make you subheading titles clear, descriptive, and complete to help users find the + right example, as shown in the section on [heading titles](#heading-titles). +- See [Capitalization](#capitalization) for guidelines on capitalizing headings. ### Heading titles @@ -589,6 +607,9 @@ Keep heading titles clear and direct. Make every word count. To accommodate sear | Configure GDK | Configuring GDK | | GitLab Release and Maintenance Policy | This section covers GitLab's Release and Maintenance Policy | | Backport to older releases | Backporting to older releases | +| GitLab Pages examples | Examples | + +For guidelines on capitalizing headings, see the section on [capitalization](#capitalization). NOTE: **Note:** If you change an existing title, be careful. Any such changes may affect not only [links](#anchor-links) diff --git a/doc/development/pipelines.md b/doc/development/pipelines.md index bfd184d7d5a..8e13c5e7efc 100644 --- a/doc/development/pipelines.md +++ b/doc/development/pipelines.md @@ -38,11 +38,9 @@ The current stages are: ## Default image -The default image is currently -`registry.gitlab.com/gitlab-org/gitlab-build-images:ruby-2.6.5-golang-1.12-git-2.24-lfs-2.9-chrome-73.0-node-12.x-yarn-1.21-postgresql-9.6-graphicsmagick-1.3.34`. +The default image is defined in <https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab-ci.yml>. -It includes Ruby 2.6.5, Go 1.12, Git 2.24, Git LFS 2.9, Chrome 73, Node 12, Yarn 1.21, -PostgreSQL 9.6, and Graphics Magick 1.3.34. +It includes Ruby, Go, Git, Git LFS, Chrome, Node, Yarn, PostgreSQL, and Graphics Magick. The images used in our pipelines are configured in the [`gitlab-org/gitlab-build-images`](https://gitlab.com/gitlab-org/gitlab-build-images) diff --git a/doc/subscriptions/index.md b/doc/subscriptions/index.md index e3dd46af6bf..1c8ecec139d 100644 --- a/doc/subscriptions/index.md +++ b/doc/subscriptions/index.md @@ -68,7 +68,10 @@ A self-managed subscription uses a hybrid model. You pay for a subscription acco Every occupied seat, whether by person, job, or bot is counted in the subscription, with the following exceptions: -- Blocked users who are blocked prior to the renewal of a subscription won't be counted as active users for the renewal subscription. They may count as active users in the subscription period in which they were originally added. +- [Deactivated](../user/admin_area/activating_deactivating_users.md#deactivating-a-user) and +[blocked](../user/admin_area/blocking_unblocking_users.md) users who are restricted prior to the +renewal of a subscription won't be counted as active users for the renewal subscription. They may +count as active users in the subscription period in which they were originally added. - Members with Guest permissions on an Ultimate subscription. - GitLab-created service accounts: `Ghost User` and `Support Bot`. diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index d1ded52585e..86b18d4012b 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -230,7 +230,7 @@ Container Scanning can be executed on an offline GitLab Ultimate installation by ``` 1. If your local Docker container registry is running securely over `HTTPS`, but you're using a - self-signed certificate, then you must set `DOCKER_INSECURE: true` in the above + self-signed certificate, then you must set `DOCKER_INSECURE: "true"` in the above `container_scanning` section of your `.gitlab-ci.yml`. It may be worthwhile to set up a [scheduled pipeline](../../../ci/pipelines/schedules.md) to automatically build a new version of the vulnerabilities database on a preset schedule. You can use the following `.gitlab-yml.ci` as a template: diff --git a/doc/user/group/roadmap/index.md b/doc/user/group/roadmap/index.md index 08f1e4af6b0..043a37d735b 100644 --- a/doc/user/group/roadmap/index.md +++ b/doc/user/group/roadmap/index.md @@ -9,25 +9,28 @@ type: reference > - In [GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/issues/5164) and later, the epic bars show their title, progress, and completed weight percentage. An Epic within a group containing **Start date** and/or **Due date** -can be visualized in a form of a timeline (e.g. a Gantt chart). The Epics Roadmap page +can be visualized in a form of a timeline (a Gantt chart). The Epics Roadmap page shows such a visualization for all the epics which are under a group and/or its subgroups. On the epic bars, you can see their title, progress, and completed weight percentage. When you hover over an epic bar, a popover appears with its title, start and due dates, and weight completed. +You can expand epics that contain child epics to show their child epics in the roadmap. +You can click the chevron **{chevron-down}** next to the epic title to expand and collapse the child epics. + ![roadmap view](img/roadmap_view_v12_9.png) -A dropdown allows you to show only open or closed epics. By default, all epics are shown. +A dropdown menu allows you to show only open or closed epics. By default, all epics are shown. ![epics state dropdown](img/epics_state_dropdown.png) -Epics in the view can be sorted by: +You can sort epics in the Roadmap view by: -- **Created date** -- **Last updated** -- **Start date** -- **Due date** +- Created date +- Last updated +- Start date +- Due date Each option contains a button that toggles the sort order between **ascending** and **descending**. The sort option and order will be persisted when browsing Epics, including the [epics list view](../epics/index.md). diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 7968f5d1463..5a070db9439 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -637,6 +637,15 @@ clicking on the context menu in the upper-right corner. If you use the **Timeline zoom** function at the bottom of the chart, logs will narrow down to the time range you selected. +### Timeline zoom and URL sharing + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198910) in GitLab 12.8. + +You can use the **Timeline zoom** function at the bottom of a chart to zoom in +on a date and time of your choice. When you click and drag the sliders to select +a different beginning or end date of data to display, GitLab adds your selected start +and end times to the URL, enabling you to share specific timeframes more easily. + ### Downloading data as CSV Data from Prometheus charts on the metrics dashboard can be downloaded as CSV. |