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>2023-02-10 00:09:12 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-02-10 00:09:12 +0300
commitd183d2d76bcc25f983c0836805c712af096bcc2f (patch)
tree982987f91e1cf268dbad55e51c4ea57292abbbd6 /doc
parent453634293e24164ffaa5cd708e47a1cebc07bcd3 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/geo/replication/troubleshooting.md2
-rw-r--r--doc/api/linked_epics.md134
-rw-r--r--doc/development/documentation/styleguide/index.md1
-rw-r--r--doc/development/documentation/styleguide/word_list.md7
-rw-r--r--doc/user/group/contribution_analytics/img/group_stats_graph.pngbin35400 -> 69052 bytes
-rw-r--r--doc/user/group/contribution_analytics/index.md45
6 files changed, 159 insertions, 30 deletions
diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md
index 804abad22a2..baa6cc4736e 100644
--- a/doc/administration/geo/replication/troubleshooting.md
+++ b/doc/administration/geo/replication/troubleshooting.md
@@ -42,7 +42,7 @@ to help identify if something is wrong:
![Geo health check](img/geo_site_health_v14_0.png)
-A site shows as "Unhealthy" if the site's status is more than 10 minutes old. It that case, try running the following in the [Rails console](../../operations/rails_console.md) on the affected site:
+A site shows as "Unhealthy" if the site's status is more than 10 minutes old. In that case, try running the following in the [Rails console](../../operations/rails_console.md) on the affected site:
```ruby
Geo::MetricsUpdateWorker.new.perform
diff --git a/doc/api/linked_epics.md b/doc/api/linked_epics.md
index 65f4c338b97..434e6080ffb 100644
--- a/doc/api/linked_epics.md
+++ b/doc/api/linked_epics.md
@@ -11,7 +11,129 @@ info: To determine the technical writer assigned to the Stage/Group associated w
If the Related Epics feature is not available in your GitLab plan, a `403` status code is returned.
-## List linked epics
+## List related epic links from a group
+
+Get a list of a given group's related epic links within group and sub-groups, filtered according to the user authorizations.
+The user needs to have access to the `source_epic` and `target_epic` to access the related epic link.
+
+```plaintext
+GET /groups/:id/epics/related_epic_links
+```
+
+Supported attributes:
+
+| Attribute | Type | Required | Description |
+| ---------- | -------------- | ---------------------- | ------------------------------------------------------------------------- |
+| `id` | integer/string | **{check-circle}** Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). |
+| `created_after` | string | no | Return related epic links created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) |
+| `created_before` | string | no | Return related epic links created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) |
+| `updated_after` | string | no | Return related epic links updated on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) |
+| `updated_before` | string | no | Return related epic links updated on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) |
+
+Example request:
+
+```shell
+curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/related_epic_links"
+```
+
+Example response:
+
+```json
+[
+ {
+ "id": 1,
+ "created_at": "2022-01-31T15:10:44.988Z",
+ "updated_at": "2022-01-31T15:10:44.988Z",
+ "link_type": "relates_to",
+ "source_epic": {
+ "id": 21,
+ "iid": 1,
+ "color": "#1068bf",
+ "text_color": "#FFFFFF",
+ "group_id": 26,
+ "parent_id": null,
+ "parent_iid": null,
+ "title": "Aspernatur recusandae distinctio omnis et qui est iste.",
+ "description": "some description",
+ "confidential": false,
+ "author": {
+ "id": 15,
+ "username": "trina",
+ "name": "Theresia Robel",
+ "state": "active",
+ "avatar_url": "https://www.gravatar.com/avatar/085e28df717e16484cbf6ceca75e9a93?s=80&d=identicon",
+ "web_url": "http://gitlab.example.com/trina"
+ },
+ "start_date": null,
+ "end_date": null,
+ "due_date": null,
+ "state": "opened",
+ "web_url": "http://gitlab.example.com/groups/flightjs/-/epics/1",
+ "references": {
+ "short": "&1",
+ "relative": "&1",
+ "full": "flightjs&1"
+ },
+ "created_at": "2022-01-31T15:10:44.988Z",
+ "updated_at": "2022-03-16T09:32:35.712Z",
+ "closed_at": null,
+ "labels": [],
+ "upvotes": 0,
+ "downvotes": 0,
+ "_links": {
+ "self": "http://gitlab.example.com/api/v4/groups/26/epics/1",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/26/epics/1/issues",
+ "group": "http://gitlab.example.com/api/v4/groups/26",
+ "parent": null
+ }
+ },
+ "target_epic": {
+ "id": 25,
+ "iid": 5,
+ "color": "#1068bf",
+ "text_color": "#FFFFFF",
+ "group_id": 26,
+ "parent_id": null,
+ "parent_iid": null,
+ "title": "Aut assumenda id nihil distinctio fugiat vel numquam est.",
+ "description": "some description",
+ "confidential": false,
+ "author": {
+ "id": 3,
+ "username": "valerie",
+ "name": "Erika Wolf",
+ "state": "active",
+ "avatar_url": "https://www.gravatar.com/avatar/9ef7666abb101418a4716a8ed4dded80?s=80&d=identicon",
+ "web_url": "http://gitlab.example.com/valerie"
+ },
+ "start_date": null,
+ "end_date": null,
+ "due_date": null,
+ "state": "opened",
+ "web_url": "http://gitlab.example.com/groups/flightjs/-/epics/5",
+ "references": {
+ "short": "&5",
+ "relative": "&5",
+ "full": "flightjs&5"
+ },
+ "created_at": "2022-01-31T15:10:45.080Z",
+ "updated_at": "2022-03-16T09:32:35.842Z",
+ "closed_at": null,
+ "labels": [],
+ "upvotes": 0,
+ "downvotes": 0,
+ "_links": {
+ "self": "http://gitlab.example.com/api/v4/groups/26/epics/5",
+ "epic_issues": "http://gitlab.example.com/api/v4/groups/26/epics/5/issues",
+ "group": "http://gitlab.example.com/api/v4/groups/26",
+ "parent": null
+ }
+ },
+ }
+]
+```
+
+## List linked epics from an epic
Get a list of a given epic's linked epics filtered according to the user authorizations.
@@ -118,6 +240,10 @@ Example response:
```json
{
+ "id": 1,
+ "created_at": "2022-01-31T15:10:44.988Z",
+ "updated_at": "2022-01-31T15:10:44.988Z",
+ "link_type": "relates_to",
"source_epic": {
"id": 21,
"iid": 1,
@@ -202,7 +328,6 @@ Example response:
"parent": null
}
},
- "link_type": "relates_to"
}
```
@@ -235,6 +360,10 @@ Example response:
```json
{
+ "id": 1,
+ "created_at": "2022-01-31T15:10:44.988Z",
+ "updated_at": "2022-01-31T15:10:44.988Z",
+ "link_type": "relates_to",
"source_epic": {
"id": 21,
"iid": 1,
@@ -319,6 +448,5 @@ Example response:
"parent": null
}
},
- "link_type": "relates_to"
}
```
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md
index 9ae3bba564f..74437ea46c9 100644
--- a/doc/development/documentation/styleguide/index.md
+++ b/doc/development/documentation/styleguide/index.md
@@ -182,6 +182,7 @@ the page is rendered to HTML. There can be only **one** level 1 heading per page
Heading levels greater than `H5` do not display in the right sidebar navigation.
- Do not skip a level. For example: `##` > `####`.
- Leave one blank line before and after the topic title.
+- If you use code in topic titles, ensure the code is in backticks.
### Backticks in Markdown
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md
index 5d7c94a6721..7e77e19c4a2 100644
--- a/doc/development/documentation/styleguide/word_list.md
+++ b/doc/development/documentation/styleguide/word_list.md
@@ -1363,16 +1363,19 @@ in present tense, active voice.
## you, your, yours
-Use **you**, **your**, and **yours** instead of **the user** and **the user's**.
-Documentation should be from the [point of view](https://design.gitlab.com/content/voice-and-tone#point-of-view) of the reader.
+Use **you** instead of **the user**, **the administrator** or **the customer**.
+Documentation should speak directly to the user, whether that user is someone installing the product,
+configuring it, administering it, or using it.
Use:
- You can configure a pipeline.
+- You can reset a user's password. (In content for an administrator)
Instead of:
- Users can configure a pipeline.
+- Administrators can reset a user's password.
## you can
diff --git a/doc/user/group/contribution_analytics/img/group_stats_graph.png b/doc/user/group/contribution_analytics/img/group_stats_graph.png
index ccfd3782c6f..1c38a9c1fdf 100644
--- a/doc/user/group/contribution_analytics/img/group_stats_graph.png
+++ b/doc/user/group/contribution_analytics/img/group_stats_graph.png
Binary files differ
diff --git a/doc/user/group/contribution_analytics/index.md b/doc/user/group/contribution_analytics/index.md
index 55345a0b865..b0347ba5caa 100644
--- a/doc/user/group/contribution_analytics/index.md
+++ b/doc/user/group/contribution_analytics/index.md
@@ -4,25 +4,26 @@ stage: Plan
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
-# Contribution Analytics **(PREMIUM)**
+# Contribution analytics **(PREMIUM)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups.
-With Contribution Analytics, you can get an overview of the [contribution events](../../profile/contributions_calendar.md#user-contribution-events) in your
-group.
+Contribution analytics provide an overview of the
+[contribution events](../../profile/contributions_calendar.md#user-contribution-events) made by your group's members.
-- Analyze your team's contributions over a period of time.
-- Identify opportunities for improvement with group members who may benefit from additional
- support.
+Use contribution analytics data visualizations to:
-## View Contribution Analytics
+- Analyze your group's contributions over a period of time.
+- Identify group members who are high-performers or may benefit from additional support.
-To view Contribution Analytics:
+## View contribution analytics
+
+To view contribution analytics:
1. On the top bar, select **Main menu > Groups** and find your group.
1. On the left sidebar, select **Analytics > Contribution**.
-Three bar graphs illustrate the number of contributions made by each group member:
+Three bar charts and a table illustrate the number of contributions made by each group member:
- Push events
- Merge requests
@@ -30,7 +31,9 @@ Three bar graphs illustrate the number of contributions made by each group membe
### View a member's contributions
-Hover over each bar to display the number of events for a specific group member.
+You can view the number of events associated with a specific group member.
+
+To do this, hover over the bar with the member's name.
![Contribution analytics bar graphs](img/group_stats_graph.png)
@@ -42,30 +45,24 @@ To do this, select the sliders (**{status-paused}**) below the chart and slide t
### Sort contributions
-Contributions per group member are also presented in tabular format. Select a column header to sort the table by that column:
-
-- Member name
-- Number of pushed events
-- Number of opened issues
-- Number of closed issues
-- Number of opened MRs
-- Number of merged MRs
-- Number of closed MRs
-- Number of total contributions
+Contributions per group member are also displayed in tabular format.
+The table columns include the members' names and the number of contributions for different events.
-![Contribution analytics contributions table](img/group_stats_table.png)
+To sort the table by a column, select the column header or the chevron (**{chevron-lg-down}**
+for descending order, **{chevron-lg-up}** for ascending order).
## Change the time period
-You can choose from the following three periods:
+You can display contribution analytics over different time periods:
- Last week (default)
- Last month
- Last three months
-Select the desired period from the calendar dropdown list.
+To change the time period of the contribution analytics, select one of the three tabs
+under **Contribution Analytics**.
-![Contribution analytics choose period](img/group_stats_cal.png)
+The selected time period applies to all charts and the table.
## Contribution analytics GraphQL API