Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
852f4fb7
Commit
852f4fb7
authored
Feb 05, 2019
by
Marcel Amirault
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clean up issues functionalities doc
parent
609e5f7d
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
37 additions
and
37 deletions
+37
-37
doc/user/project/issues/issues_functionalities.md
doc/user/project/issues/issues_functionalities.md
+37
-37
No files found.
doc/user/project/issues/issues_functionalities.md
View file @
852f4fb7
...
@@ -4,7 +4,7 @@ Please read through the [GitLab Issue Documentation](index.md) for an overview o
...
@@ -4,7 +4,7 @@ Please read through the [GitLab Issue Documentation](index.md) for an overview o
## Issues Functionalities
## Issues Functionalities
The image bel
low illustrates how
an issue looks like:
The image bel
ow illustrates what
an issue looks like:
![
Issue view
](
img/issues_main_view_numbered.jpg
)
![
Issue view
](
img/issues_main_view_numbered.jpg
)
...
@@ -13,7 +13,7 @@ You can find all the information on that issue on one screen.
...
@@ -13,7 +13,7 @@ You can find all the information on that issue on one screen.
### Issue screen
### Issue screen
An issue starts with its status (open or closed), followed by its author,
An issue starts with its status (open or closed), followed by its author,
and includes many other functionalities, numbered
o
n the image above to
and includes many other functionalities, numbered
i
n the image above to
explain what they mean, one by one.
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.
Many of the elements of the issue screen refresh automatically, such as the title and description, when they are changed by another user.
...
@@ -27,7 +27,7 @@ Comments and system notes also appear automatically in response to various actio
...
@@ -27,7 +27,7 @@ Comments and system notes also appear automatically in response to various actio
#### 2. Todos
#### 2. Todos
-
Add todo: add that issue to your
[
GitLab Todo
](
../../../workflow/todos.
html
)
list
-
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)
-
Mark todo as done: mark that issue as done (reflects on the Todo list)
#### 3. Assignee
#### 3. Assignee
...
@@ -43,14 +43,14 @@ assigned to them if they created the issue themselves.
...
@@ -43,14 +43,14 @@ assigned to them if they created the issue themselves.
##### 3.1. Multiple Assignees **[STARTER]**
##### 3.1. Multiple Assignees **[STARTER]**
Often multiple people
likely
work on the same issue together,
Often multiple people work on the same issue together,
which can
especially be
difficult to track in large teams
which can
be especially
difficult to track in large teams
where there is shared ownership of an issue.
where there is shared ownership of an issue.
In
[
GitLab Starter
](
https://about.gitlab.com/pricing/
)
, you can
also
In
[
GitLab Starter
](
https://about.gitlab.com/pricing/
)
, you can
select multiple assignees
to an issue.
assign multiple people
to an issue.
Learn more
o
n the
[
Multiple Assignees documentation
](
https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html
)
.
Learn more
i
n the
[
Multiple Assignees documentation
](
https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html
)
.
#### 4. Milestone
#### 4. Milestone
...
@@ -58,40 +58,39 @@ Learn more on the [Multiple Assignees documentation](https://docs.gitlab.com/ee/
...
@@ -58,40 +58,39 @@ Learn more on the [Multiple Assignees documentation](https://docs.gitlab.com/ee/
#### 5. Time Tracking
#### 5. Time Tracking
-
Estimate time: add an estimate
time in which the issue will be implemented
-
Estimate time: add an estimate
of the time it will take to resolve the issue.
-
Spend: add the time spent on the
implementation of that
issue
-
Spend: add the time spent on the
resolution of the
issue
> **Note:**
> **Note:**
Both estimate and spend times are set via
[
GitLab Quick Actions
](
../quick_actions.md
)
.
Both estimate and spend times are set via
[
GitLab Quick Actions
](
../quick_actions.md
)
.
Learn more
o
n the
[
Time Tracking documentation
](
../../../workflow/time_tracking.md
)
.
Learn more
i
n the
[
Time Tracking documentation
](
../../../workflow/time_tracking.md
)
.
#### 6. Due date
#### 6. Due date
When you work on a tight schedule,
and
it's important to
When you work on a tight schedule, it's important to
have a way to set
up
a deadline for implementations and for solving
have a way to set a deadline for implementations and for solving
problems. This can be
facilitated by the
[
due date
](
due_dates.md
)
)
. Due dates
problems. This can be
done in the
[
due date
](
due_dates.md
)
element
. Due dates
can be changed as many times as needed.
can be changed as many times as needed.
#### 7. Labels
#### 7. Labels
Categorize issues by giving them
[
labels
](
../labels.md
)
. They help to
Categorize issues by giving them
[
labels
](
../labels.md
)
. They help to
organize
team's workflows, once
they enable you to work with the
organize
workflows, and
they enable you to work with the
[
GitLab Issue Board
](
index.md#
gitlab-
issue-board
)
.
[
GitLab Issue Board
](
index.md#issue-board
)
.
Group Labels, which allow you to use the same labels
per
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,
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.
but they are immediately available to all projects in the group.
> **Tip:**
> **Tip:**
if the label doesn't exist yet, when you click
**Edit**
,
it opens a dropdown menu from which you can select
**Create new label**
.
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]**
#### 8. Weight **[STARTER]**
-
Attribute a weight (in a 0 to 9 range) to that issue. Easy to complete
-
Assign a weight. Larger values are used to indicate more effort is required to complete the issue. Only positive values or zero are allowed.
should weight 1 and very hard to complete should weight 9.
Learn more
o
n the
[
Issue Weight documentation
](
https://docs.gitlab.com/ee/workflow/issue_weight.html
)
.
Learn more
i
n the
[
Issue Weight documentation
](
https://docs.gitlab.com/ee/workflow/issue_weight.html
)
.
#### 9. Participants
#### 9. Participants
...
@@ -102,32 +101,33 @@ Learn more on the [Issue Weight documentation](https://docs.gitlab.com/ee/workfl
...
@@ -102,32 +101,33 @@ Learn more on the [Issue Weight documentation](https://docs.gitlab.com/ee/workfl
-
Subscribe: if you are not a participant of the discussion on that issue, but
-
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.
want to receive notifications on each new input, subscribe to it.
-
Unsubscribe: if you are receiving notifications on that issue but no
-
Unsubscribe: if you are receiving notifications on that issue but no
longer want to receive them, unsubscribe
to
it.
longer want to receive them, unsubscribe
from
it.
Read more
on the
[
notifications documentation
](
../../../workflow/notifications.md#issue
-merge-request-events
)
.
Read more
in the
[
notifications documentation
](
../../../workflow/notifications.md#issue-
-merge-request-events
)
.
#### 11. Reference
#### 11. Reference
-
A quick "copy to clipboard" button
to
that issue's reference,
`foo/bar#xxx`
, where
`foo`
is the
`username`
or
`groupname`
,
`bar`
-
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.
is the
`project-name`
, and
`xxx`
is the issue number.
#### 12. Title and description
#### 12. Title and description
-
Title: a plain text title describing the issue's subject.
-
Title: a plain text title for describing the subject of the issue.
-
Description: a text field which fully supports
[
GitLab Flavored Markdown
](
../../markdown.md#gitlab-flavored-markdown-gfm
)
.
-
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.
@m
entions
#### 13.
M
entions
-
You can
either
`@mention`
a user or a group present in your
-
You can
mention a user or a group present in your GitLab instance with
GitLab instance and they will be notified via todos and email, unless that
`@username`
or
`@groupname`
and they will be notified via todos and email, unless
person has
disabled all notifications in their profile settings.
they have
disabled all notifications in their profile settings.
-
Mentions for yourself (the current logged in user),
will be distinctly
highlighted
-
Mentions for yourself (the current logged in user),
will be
highlighted
in a different color, allowing you to easily see which comments involve you,
in a different color, allowing you to easily see which comments involve you,
helping you focus on them quickly.
helping you focus on them quickly.
To change your
[
notification settings
](
../../../workflow/notifications.md
)
navigate to
To change your
[
notification settings
](
../../../workflow/notifications.md
)
,
navigate to
**Profile Settings**
>
**Notifications**
>
**Global notification level**
**Profile Settings**
>
**Notifications**
>
**Global notification level**
and choose your preference
s
from the dropdown menu.
and choose your preference from the dropdown menu.
> **Tip:**
> **Tip:**
Avoid mentioning
`@all`
in issues and merge requests,
Avoid mentioning
`@all`
in issues and merge requests,
...
@@ -138,14 +138,14 @@ interpreted as spam.
...
@@ -138,14 +138,14 @@ interpreted as spam.
#### 14. Related Merge Requests
#### 14. Related Merge Requests
-
Any merge requests mentioned in that issue's description
-
Any merge requests mentioned in that issue's description
or in the issue thread.
or in the issue
discussion
thread.
#### 15. Award emoji
#### 15. Award emoji
-
Award an emoji to that issue.
-
Award an emoji to that issue.
> **Tip:**
> **Tip:**
Posting "+1" as
comments in threads spam all
Posting "+1" as
a comment in a thread spams all subscribed
participants of that issue. Awarding an emoji is a way to let them
participants of that issue. Awarding an emoji is a way to let them
know you like it without spamming them.
know you like it without spamming them.
...
@@ -157,7 +157,7 @@ These text fields also fully support
...
@@ -157,7 +157,7 @@ These text fields also fully support
#### 17. Comment, start a discussion, or comment and close
#### 17. Comment, start a discussion, or comment and close
Once you wr
ote your
comment, you can either:
Once you wr
ite a
comment, you can either:
-
Click "Comment" and your comment will be published.
-
Click "Comment" and your comment will be published.
-
Click "Start discussion": start a thread within that issue's thread to discuss specific points.
-
Click "Start discussion": start a thread within that issue's thread to discuss specific points.
...
@@ -167,6 +167,6 @@ Once you wrote your comment, you can either:
...
@@ -167,6 +167,6 @@ Once you wrote your comment, you can either:
-
Create a new merge request (with a new source branch named after the issue) in one action.
-
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
The merge request will automatically inherit the milestone and labels of the issue. The merge
request will automatically close that issue
as soon a
s merged.
request will automatically close that issue
when it i
s merged.
-
Optionally, you can just create a
[
new branch
](
../repository/web_editor.md#create-a-new-branch-from-an-issue
)
-
Optionally, you can just create a
[
new branch
](
../repository/web_editor.md#create-a-new-branch-from-an-issue
)
named after that issue.
named after that issue.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment