From f581e72dee3d41f447b50c60e036206b6a148766 Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Tue, 9 Apr 2019 10:54:51 +0000 Subject: Docs: Fix anchors related to issues --- doc/gitlab-basics/create-issue.md | 4 +- doc/user/group/index.md | 2 +- doc/user/index.md | 4 +- doc/user/project/issue_board.md | 2 +- doc/user/project/issues/create_new_issue.md | 2 +- doc/user/project/issues/index.md | 6 +- doc/user/project/issues/issue_data_and_actions.md | 172 ++++++++++++++++++++++ doc/user/project/issues/issues_functionalities.md | 172 ---------------------- 8 files changed, 182 insertions(+), 182 deletions(-) create mode 100644 doc/user/project/issues/issue_data_and_actions.md delete mode 100644 doc/user/project/issues/issues_functionalities.md diff --git a/doc/gitlab-basics/create-issue.md b/doc/gitlab-basics/create-issue.md index 818a03a6f02..6e2a09fc030 100644 --- a/doc/gitlab-basics/create-issue.md +++ b/doc/gitlab-basics/create-issue.md @@ -1,5 +1,5 @@ --- -redirect_to: '../user/project/issues/index.md#new-issue' +redirect_to: '../user/project/issues/index.md#issue-actions' --- -This document was moved to [another location](../user/project/issues/index.md#new-issue). +This document was moved to [another location](../user/project/issues/index.md#issue-actions). diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 9c3f6fcec9b..74735886350 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -58,7 +58,7 @@ By doing so: ## Issues and merge requests within a group Issues and merge requests are part of projects. For a given group, view all the -[issues](../project/issues/index.md#issues-per-group) and [merge requests](../project/merge_requests/index.md#merge-requests-per-group) across all the projects in that group, +[issues](../project/issues/index.md#issues-list) and [merge requests](../project/merge_requests/index.md#merge-requests-per-group) across all the projects in that group, together in a single list view. ## Create a new group diff --git a/doc/user/index.md b/doc/user/index.md index d408504249e..626246447f3 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -38,8 +38,8 @@ GitLab is a Git-based platform that integrates a great number of essential tools - Hosting code in repositories with version control. - Tracking proposals for new implementations, bug reports, and feedback with a - fully featured [Issue Tracker](project/issues/index.md#issue-tracker). -- Organizing and prioritizing with [Issue Boards](project/issues/index.md#issue-board). + fully featured [Issue Tracker](project/issues/index.md#issues-list). +- Organizing and prioritizing with [Issue Boards](project/issues/index.md#issue-boards). - Reviewing code in [Merge Requests](project/merge_requests/index.md) with live-preview changes per branch with [Review Apps](../ci/review_apps/index.md). - Building, testing, and deploying with built-in [Continuous Integration](../ci/README.md). diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index ca19ce4d328..ad47b848bea 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -42,7 +42,7 @@ below. ## How it works The Issue Board builds on GitLab's existing -[issue tracking functionality](issues/index.md#issue-tracker) and +[issue tracking functionality](issues/index.md#issues-list) and leverages the power of [labels](labels.md) by utilizing them as lists of the scrum board. With the Issue Board you can have a different view of your issues while diff --git a/doc/user/project/issues/create_new_issue.md b/doc/user/project/issues/create_new_issue.md index 40040e44d64..9a147deecd4 100644 --- a/doc/user/project/issues/create_new_issue.md +++ b/doc/user/project/issues/create_new_issue.md @@ -7,7 +7,7 @@ the information illustrated on the image below. ![New issue from the issues list](img/new_issue.png) -Read through the [issues functionalities documentation](issues_functionalities.md#issues-functionalities) +Read through the [issue data and actions documentation](issue_data_and_actions.md#parts-of-an-issue) to understand these fields one by one. ## New issue from the Issue Tracker diff --git a/doc/user/project/issues/index.md b/doc/user/project/issues/index.md index 14e023207e8..c82b7f100d2 100644 --- a/doc/user/project/issues/index.md +++ b/doc/user/project/issues/index.md @@ -78,7 +78,7 @@ While you can view and manage the full detail of an issue at its URL, you can al On an issue’s page, you can view all aspects of the issue, and you can also modify them if you you have the necessary [permissions](../../permissions.md). -For more information, see the [Issue Functionalities](issues_functionalities.md) page. +For more information, see the [Issue Data and Actions](issue_data_and_actions.md) page. ### Issues list @@ -86,7 +86,7 @@ For more information, see the [Issue Functionalities](issues_functionalities.md) On the Issues List, you can view all issues in the current project, or from multiple projects when opening the Issues List from the higher-level group context. Filter the issue list by [any search query](../../search/index.md#issues-and-merge-requests-per-project) and/or specific metadata, such as label(s), assignees(s), status, and more. From this view, you can also make certain changes [in bulk](../bulk_editing.md) to the displayed issues. -For more information, see the [Issue Functioinalities](issues_functionalities.md) page. +For more information, see the [Issue Data and Actions](issue_data_and_actions.md) page. ### Issue boards @@ -123,7 +123,7 @@ For more information, see [Crosslinking issues](crosslinking_issues.md). - [Close an issue](closing_issues.md) - [Move an issue](moving_issues.md) - [Delete an issue](deleting_issues.md) -- [Create a merge request from an issue](issues_functionalities.md#18-new-merge-request) +- [Create a merge request from an issue](issue_data_and_actions.md#18-new-merge-request) ## Advanced issue management diff --git a/doc/user/project/issues/issue_data_and_actions.md b/doc/user/project/issues/issue_data_and_actions.md new file mode 100644 index 00000000000..653bd94e513 --- /dev/null +++ b/doc/user/project/issues/issue_data_and_actions.md @@ -0,0 +1,172 @@ +# Issue Data and Actions + +Please read through the [GitLab Issue Documentation](index.md) for an overview on GitLab Issues. + +## Parts of an Issue + +The image below illustrates what an issue looks like: + +![Issue view](img/issues_main_view_numbered.jpg) + +You can find all the information on that issue on one screen. + +### Issue screen + +An issue starts with its status (open or closed), followed by its author, +and includes many other functionalities, numbered in the image above to +explain what they mean, one by one. + +Many of the elements of the issue screen refresh automatically, such as the title and description, when they are changed by another user. +Comments and system notes also appear automatically in response to various actions and content updates. + +#### 1. New Issue, close issue, edit + +- New issue: create a new issue in the same project +- Close issue: close this issue +- Edit: edit the same fields available when you create an issue. + +#### 2. Todos + +- Add todo: add that issue to your [GitLab Todo](../../../workflow/todos.md) list +- Mark todo as done: mark that issue as done (reflects on the Todo list) + +#### 3. Assignee + +Whenever someone starts to work on an issue, it can be assigned +to that person. The assignee can be changed as much as needed. +The idea is that the assignee is responsible for that issue until +it's reassigned to someone else to take it from there. + +> **Tip:** +if a user is not member of that project, it can only be +assigned to them if they created the issue themselves. + +##### 3.1. Multiple Assignees **[STARTER]** + +Often multiple people work on the same issue together, +which can be especially difficult to track in large teams +where there is shared ownership of an issue. + +In [GitLab Starter](https://about.gitlab.com/pricing/), you can +assign multiple people to an issue. + +Learn more in the [Multiple Assignees documentation](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html). + +#### 4. Milestone + +- Select a [milestone](../milestones/index.md) to attribute that issue to. + +#### 5. Time Tracking + +- Estimate time: add an estimate of the time it will take to resolve the issue. +- Spend: add the time spent on the resolution of the issue + +> **Note:** +Both estimate and spend times are set via [GitLab Quick Actions](../quick_actions.md). + +Learn more in the [Time Tracking documentation](../../../workflow/time_tracking.md). + +#### 6. Due date + +When you work on a tight schedule, it's important to +have a way to set a deadline for implementations and for solving +problems. This can be done in the [due date](due_dates.md) element. Due dates +can be changed as many times as needed. + +#### 7. Labels + +Categorize issues by giving them [labels](../labels.md). They help to +organize workflows, and they enable you to work with the +[GitLab Issue Board](index.md#issue-boards). + +Group Labels, which allow you to use the same labels for a +group of projects, can be also given to issues. They work exactly the same, +but they are immediately available to all projects in the group. + +> **Tip:** +If a label doesn't exist yet, you can click **Edit**, and it opens a dropdown menu from which you can select **Create new label**. + +#### 8. Weight **[STARTER]** + +- Assign a weight. Larger values are used to indicate more effort is required to complete the issue. Only positive values or zero are allowed. + +Learn more in the [Issue Weight documentation](https://docs.gitlab.com/ee/workflow/issue_weight.html). + +#### 9. Participants + +- People involved in that issue (mentioned in the description or in the [discussion](../../discussions/index.md)). + +#### 10. Notifications + +- Subscribe: if you are not a participant of the discussion on that issue, but + want to receive notifications on each new input, subscribe to it. +- Unsubscribe: if you are receiving notifications on that issue but no + longer want to receive them, unsubscribe from it. + +Read more in the [notifications documentation](../../../workflow/notifications.md#issue--merge-request-events). + +#### 11. Reference + +- A quick "copy to clipboard" button for that issue's reference, `foo/bar#xxx`, where `foo` is the `username` or `groupname`, `bar` + is the `project-name`, and `xxx` is the issue number. + +#### 12. Title and description + +- Title: a plain text title for describing the subject of the issue. +- Description: a large text field which fully supports [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm), + to describe all the details of the issue. + +#### 13. Mentions + +- You can mention a user or a group present in your GitLab instance with + `@username` or `@groupname` and they will be notified via todos and email, unless + they have disabled all notifications in their profile settings. +- Mentions for yourself (the current logged in user), will be highlighted + in a different color, allowing you to easily see which comments involve you, + helping you focus on them quickly. + +To change your [notification settings](../../../workflow/notifications.md), navigate to +**Profile Settings** > **Notifications** > **Global notification level** +and choose your preference from the dropdown menu. + +> **Tip:** +Avoid mentioning `@all` in issues and merge requests, +as it sends an email notification +to all the members of that project's group, which can be +interpreted as spam. + +#### 14. Related Merge Requests + +- Any merge requests mentioned in that issue's description + or in the issue discussion thread. + +#### 15. Award emoji + +- Award an emoji to that issue. + +> **Tip:** +Posting "+1" as a comment in a thread spams all subscribed +participants of that issue. Awarding an emoji is a way to let them +know you like it without spamming them. + +#### 16. Thread + +- Comments: collaborate to that issue by posting comments in its thread. + These text fields also fully support + [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). + +#### 17. Comment, start a discussion, or comment and close + +Once you write a comment, you can either: + +- Click "Comment" and your comment will be published. +- Click "Start discussion": start a thread within that issue's thread to discuss specific points. +- Click "Comment and close issue": post your comment and close that issue in one click. + +#### 18. New Merge Request + +- Create a new merge request (with a new source branch named after the issue) in one action. + The merge request will automatically inherit the milestone and labels of the issue. The merge + request will automatically close that issue when it is merged. +- Optionally, you can just create a [new branch](../repository/web_editor.md#create-a-new-branch-from-an-issue) + named after that issue. diff --git a/doc/user/project/issues/issues_functionalities.md b/doc/user/project/issues/issues_functionalities.md deleted file mode 100644 index 4a90ce613d9..00000000000 --- a/doc/user/project/issues/issues_functionalities.md +++ /dev/null @@ -1,172 +0,0 @@ -# Issue Data and Actions - -Please read through the [GitLab Issue Documentation](index.md) for an overview on GitLab Issues. - -## Parts of an Issue - -The image below illustrates what an issue looks like: - -![Issue view](img/issues_main_view_numbered.jpg) - -You can find all the information on that issue on one screen. - -### Issue screen - -An issue starts with its status (open or closed), followed by its author, -and includes many other functionalities, numbered in the image above to -explain what they mean, one by one. - -Many of the elements of the issue screen refresh automatically, such as the title and description, when they are changed by another user. -Comments and system notes also appear automatically in response to various actions and content updates. - -#### 1. New Issue, close issue, edit - -- New issue: create a new issue in the same project -- Close issue: close this issue -- Edit: edit the same fields available when you create an issue. - -#### 2. Todos - -- Add todo: add that issue to your [GitLab Todo](../../../workflow/todos.md) list -- Mark todo as done: mark that issue as done (reflects on the Todo list) - -#### 3. Assignee - -Whenever someone starts to work on an issue, it can be assigned -to that person. The assignee can be changed as much as needed. -The idea is that the assignee is responsible for that issue until -it's reassigned to someone else to take it from there. - -> **Tip:** -if a user is not member of that project, it can only be -assigned to them if they created the issue themselves. - -##### 3.1. Multiple Assignees **[STARTER]** - -Often multiple people work on the same issue together, -which can be especially difficult to track in large teams -where there is shared ownership of an issue. - -In [GitLab Starter](https://about.gitlab.com/pricing/), you can -assign multiple people to an issue. - -Learn more in the [Multiple Assignees documentation](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html). - -#### 4. Milestone - -- Select a [milestone](../milestones/index.md) to attribute that issue to. - -#### 5. Time Tracking - -- Estimate time: add an estimate of the time it will take to resolve the issue. -- Spend: add the time spent on the resolution of the issue - -> **Note:** -Both estimate and spend times are set via [GitLab Quick Actions](../quick_actions.md). - -Learn more in the [Time Tracking documentation](../../../workflow/time_tracking.md). - -#### 6. Due date - -When you work on a tight schedule, it's important to -have a way to set a deadline for implementations and for solving -problems. This can be done in the [due date](due_dates.md) element. Due dates -can be changed as many times as needed. - -#### 7. Labels - -Categorize issues by giving them [labels](../labels.md). They help to -organize workflows, and they enable you to work with the -[GitLab Issue Board](index.md#issue-board). - -Group Labels, which allow you to use the same labels for a -group of projects, can be also given to issues. They work exactly the same, -but they are immediately available to all projects in the group. - -> **Tip:** -If a label doesn't exist yet, you can click **Edit**, and it opens a dropdown menu from which you can select **Create new label**. - -#### 8. Weight **[STARTER]** - -- Assign a weight. Larger values are used to indicate more effort is required to complete the issue. Only positive values or zero are allowed. - -Learn more in the [Issue Weight documentation](https://docs.gitlab.com/ee/workflow/issue_weight.html). - -#### 9. Participants - -- People involved in that issue (mentioned in the description or in the [discussion](../../discussions/index.md)). - -#### 10. Notifications - -- Subscribe: if you are not a participant of the discussion on that issue, but - want to receive notifications on each new input, subscribe to it. -- Unsubscribe: if you are receiving notifications on that issue but no - longer want to receive them, unsubscribe from it. - -Read more in the [notifications documentation](../../../workflow/notifications.md#issue--merge-request-events). - -#### 11. Reference - -- A quick "copy to clipboard" button for that issue's reference, `foo/bar#xxx`, where `foo` is the `username` or `groupname`, `bar` - is the `project-name`, and `xxx` is the issue number. - -#### 12. Title and description - -- Title: a plain text title for describing the subject of the issue. -- Description: a large text field which fully supports [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm), - to describe all the details of the issue. - -#### 13. Mentions - -- You can mention a user or a group present in your GitLab instance with - `@username` or `@groupname` and they will be notified via todos and email, unless - they have disabled all notifications in their profile settings. -- Mentions for yourself (the current logged in user), will be highlighted - in a different color, allowing you to easily see which comments involve you, - helping you focus on them quickly. - -To change your [notification settings](../../../workflow/notifications.md), navigate to -**Profile Settings** > **Notifications** > **Global notification level** -and choose your preference from the dropdown menu. - -> **Tip:** -Avoid mentioning `@all` in issues and merge requests, -as it sends an email notification -to all the members of that project's group, which can be -interpreted as spam. - -#### 14. Related Merge Requests - -- Any merge requests mentioned in that issue's description - or in the issue discussion thread. - -#### 15. Award emoji - -- Award an emoji to that issue. - -> **Tip:** -Posting "+1" as a comment in a thread spams all subscribed -participants of that issue. Awarding an emoji is a way to let them -know you like it without spamming them. - -#### 16. Thread - -- Comments: collaborate to that issue by posting comments in its thread. - These text fields also fully support - [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). - -#### 17. Comment, start a discussion, or comment and close - -Once you write a comment, you can either: - -- Click "Comment" and your comment will be published. -- Click "Start discussion": start a thread within that issue's thread to discuss specific points. -- Click "Comment and close issue": post your comment and close that issue in one click. - -#### 18. New Merge Request - -- Create a new merge request (with a new source branch named after the issue) in one action. - The merge request will automatically inherit the milestone and labels of the issue. The merge - request will automatically close that issue when it is merged. -- Optionally, you can just create a [new branch](../repository/web_editor.md#create-a-new-branch-from-an-issue) - named after that issue. -- cgit v1.2.1