|
1 | 1 | --- |
2 | | -title: Inbox |
| 2 | +title: Triage issues before adding them to your project |
| 3 | +sidebarTitle: Intake |
3 | 4 | --- |
4 | 5 |
|
5 | | -Inbox is a Plane-only feature that lets project members (`guests` and `viewers`) create issues and project admins (`admin` and `members`) add issues inside a project. Inbox can take bug reports, feature or service requests, or raise a ticket by stakeholders, customers, or clients. Issues created in the inbox can then be accepted to move them to the Project’s workflow. Inbox functions at the project level and is toggled off by default. It can be enabled from the `Features` tab under project settings. |
6 | | -<video controls> |
7 | | - <source src="/images/inbox/Enable Inbox feature.mp4" type="video/mp4"/> |
8 | | -</video> |
9 | | -## Create Issue in Inbox |
| 6 | +Intake is a Plane-only feature that lets `Guests` create issues following which `Admins` and `Members` can move these issues inside a project. Intake can take bug reports, feature or service requests, or raise a ticket by stakeholders, customers, or clients. Issues created in Intake can then be accepted to move them to the Project’s workflow. |
10 | 7 |
|
11 | | -Users with guest and above roles can create issues in the Inbox. To create an issue, |
| 8 | +## Enable Intake |
12 | 9 |
|
13 | | -- Head to Inbox from the project sidebar. |
14 | | -- Click on the ‘Add Issue’ button at the top right corner. |
15 | | -- Enter all the details that apply. Issue title, description, and properties. |
16 | | -<video controls> |
17 | | - <source src="/images/inbox/Create issue in Inbox.mp4" type="video/mp4"/> |
18 | | -</video> |
19 | | -## Properties in an Inbox issue |
| 10 | +Intake functions at the project level and is toggled off by default. Project `Admins` can enable the Intake feature for the project. |
20 | 11 |
|
21 | | -For an issue in the inbox, you can choose to assign the following properties, |
| 12 | +1. Click the three-dots icon next to your project name on the left pane and click **Settings**. |
| 13 | +2. Select **Features** on the right pane. |
| 14 | +3. Switch on the toggle button for the **Intake** feature to enable it on the project. |
22 | 15 |
|
23 | | -1. State - If the issue in the inbox is still being triaged, you can assign it to the proper state to help you identify the progress before moving it to your project. |
24 | | -2. Assignees - If the issue needs to be triaged or prioritized by a specific member in your team, you can simply assign it to them |
25 | | -3. Priority - Helps you or the issue creator set the priority of the issue to align the expectations on how quickly the issue should be acted upon. |
26 | | -4. Due dates - You can also track when the issue needs to be prioritized or triaged by adding due dates. |
27 | | -5. Labels - Helps you categorize issues using the same labels available in the project; you can also create a new label from here to categorize issues. |
| 16 | + <Frame></Frame> |
28 | 17 |
|
29 | | -A `guest` or `viewer` can assign this properties at the time of creating an inbox issue. However, these properties can be overridden by project `admin` or `member` later. |
30 | | -<Frame> |
31 | | - <img src="/images/inbox/inbox-properties.png" /> |
32 | | -</Frame> |
33 | | -## Action for an Inbox issue |
| 18 | +## Create Issue in Intake |
34 | 19 |
|
35 | | -When a project member creates an issue, it is added to the ‘Pending’ state. An Inbox issue can then be accepted, declined, snoozed for a later time, or marked as duplicate. |
| 20 | +Users with a `Guest` role can create issues in Intake. To create an issue: |
36 | 21 |
|
37 | | -- Accepting an Issue |
38 | | - |
39 | | - You can accept a ‘pending’ issue, after which the state changes to ‘backlog’ (or the default state set for that project.) This can be done by clicking on the ‘accept’ button present on any pending issue. This will open a modal where you can change the issue details before moving it to your project. |
40 | | - <video controls> |
41 | | - <source src="/images/inbox/Accept inbox issue.mp4" type="video/mp4"/> |
42 | | - </video> |
43 | | -- Declining an Issue |
44 | | - |
45 | | - If the issue is not relevant to your project, you can chose to decline it. An issue can be declined by clicking on ‘decline’ button present on any pending issue. Once the issue is declined, it ends up in the cancelled state of your project. |
46 | | - <video controls> |
47 | | - <source src="/images/inbox/Declining inbox issue.mp4" type="video/mp4"/> |
48 | | - </video> |
49 | | -- Snoozing an Issue |
| 22 | +1. Click on **Intake** under the project on the sidebar. |
| 23 | +2. Click the **Add Issue** button at the top right corner. |
| 24 | +<Frame></Frame> |
| 25 | +3. Enter the required details and click the **Create Issue** button. |
| 26 | + |
| 27 | + <Frame></Frame> |
| 28 | + |
| 29 | +### Properties |
| 30 | + |
| 31 | +A `Guest` role can assign properties when creating an Intake issue. However, these properties can be overridden by the project `Admin` or `Member` later. |
| 32 | + |
| 33 | +For an issue in the Intake, you can choose to assign the following properties: |
| 34 | + |
| 35 | +| Property | Description | |
| 36 | +| --------------| ------------------- | |
| 37 | +| State | If the issue in Intake is still being triaged, you can assign it to a state to help you identify the progress before moving it to your project. |
| 38 | +| Priority | Set the priority of the issue to align the expectations on how quickly the issue should be acted upon. |
| 39 | +| Assignees | Assign the team member who should triage or prioritize the issue. |
| 40 | +| Labels | Categorize issues using the labels available in the project. |
| 41 | +| Due date | Set when the issue needs to be prioritized or triaged by adding a due date. |
| 42 | + |
| 43 | +## Intake issue actions |
| 44 | + |
| 45 | +When a Guest creates an issue in Intake, it is added to the `Pending` state. Admin and Member roles can accept, decline, snooze or mark the issue as a duplicate. |
| 46 | + |
| 47 | +### Accept issue |
| 48 | + |
| 49 | + <Frame></Frame> |
50 | 50 |
|
51 | | - An issue can be snoozed to review it at a later time. Steps to snooze an issue: |
| 51 | +1. Open a pending issue in Intake. |
| 52 | +2. Click the **Accept** button on the top right. This will open a modal where you can change the issue details before moving it to your project. |
| 53 | +3. Click the **Add to project** button to move the issue from **Intake** to **Issues** under the project. The issue will be visible under the **State** selected when creating or accepting the Intake issue. |
| 54 | + |
| 55 | +### Decline issue |
52 | 56 |
|
53 | | - 1. Open a pending issue |
54 | | - 2. Hover over to the ellipses in the top right corner |
55 | | - 3. Select snooze option |
56 | | - 4. Select a date |
| 57 | +If the issue is not relevant to your project, you can choose to decline it. Click the **Decline** button present on any pending issue to decline it. Once the issue is declined, it ends up in the `Cancelled` state under your project. |
| 58 | + |
| 59 | +### Snooze issue |
57 | 60 |
|
58 | | - The issue is now snoozed and can be accessed from the filters drop-down. |
59 | | - <Frame> |
60 | | - <img src="/images/inbox/snooze-issue.png" /> |
61 | | - </Frame> |
62 | | -- Marking an issue as Duplicate: |
| 61 | +An issue can be snoozed to review it at a later time. |
| 62 | + |
| 63 | + <Frame></Frame> |
63 | 64 |
|
64 | | - In cases where a similar issue exists in your project, an inbox issue can be marked as duplicate. |
| 65 | +1. Open a pending issue in Intake. |
| 66 | +2. Click on the three dots icon in the top right corner. |
| 67 | +3. Select the **Snooze** option in the menu. |
| 68 | +4. Select a date to review it later. |
65 | 69 |
|
66 | | - Steps to mark an issue as duplicate: |
| 70 | +The issue is moved out of pending Intake issues and can be accessed in the **Filters** drop-down under `Open` issues. You can also un-snooze the issue from the three dots menu. |
| 71 | + |
| 72 | +### Mark issue as duplicate |
67 | 73 |
|
68 | | - 1. Open a pending issue |
69 | | - 2. Hover over to the ellipses in the top right corner |
70 | | - 3. Select mark as duplicate option |
71 | | - 4. Select an issue of which the current issue is the duplicate |
| 74 | +In cases where a similar issue exists in your project, an Intake issue can be marked as duplicate. |
72 | 75 |
|
73 | | - The issue is now declined with a ‘duplicate’ label on it. |
74 | | - <Frame> |
75 | | - <img src="/images/inbox/mark-as-duplicate.png" /> |
76 | | - </Frame> |
77 | | - |
78 | | -## Open and closed issues |
| 76 | +1. Open a pending issue in Intake. |
| 77 | +2. Click on the three dots icon in the top right corner. |
| 78 | +3. Select the **Mark as duplicate** option in the menu. |
| 79 | +4. Select an issue in the project that is a duplicate of the Intake issue. |
79 | 80 |
|
80 | | -You can view Open or closed issues on the Inbox sidebar. |
| 81 | + <Frame></Frame> |
| 82 | + |
| 83 | +The issue is now declined with a ‘Duplicate’ label on it. It will also appear in the `Cancelled` state under your project. |
81 | 84 |
|
82 | | -‘Pending’ or ‘Snoozed’ issues are considered Open issues. Further action can take place on such issues. Whereas ‘Accepted,’ ‘Declined,’ and ‘Duplicate’ are closed issues. No further action is required on closed issues. |
83 | | -<img width="300" noZoom src="/images/inbox/inbox-tabs.png" /> |
| 85 | +### Delete issue |
84 | 86 |
|
| 87 | +Only `Admins` have permission to delete Intake issues before it goes through the workflow. Deleted issues will not appear under any label in the `Closed` issues of Intake. |
| 88 | + |
| 89 | +## View Intake issues |
85 | 90 |
|
86 | | -## Sorting and Filtering |
| 91 | +You can view **Open** and **Closed** issues in Intake by clicking on the appropriate tabs. |
87 | 92 |
|
88 | | -Like issues, sorting and filtering can create a focused view in an Inbox. Filters and sorting can be applied to the list of issues simultaneously. |
| 93 | + <img width="300" noZoom src="/images/inbox/inbox-tabs.png" /> |
89 | 94 |
|
90 | | -**Filtering inbox issues** |
| 95 | +`Pending` or `Snoozed` issues are considered open issues. Further action can take place on such issues. Whereas, `Accepted`, `Declined`, and `Duplicate` appear under closed issues. No further action is required on closed issues. |
91 | 96 |
|
92 | | -Filters can be assigned from the filters dropdown available on the left-hand side of the Inbox page. Inbox issues can be filtered by issue status, state, priority, assignee, created by, labels, created date, and last updated date. |
| 97 | +### Sort and filter |
93 | 98 |
|
94 | | -**Sorting inbox issues** |
| 99 | +Like issues in the project, sorting and filtering can create a focused view of issues in Intake. Filters and sorting can be applied to a list of issues simultaneously. |
95 | 100 |
|
96 | | -Next to filters, you can use the sort drop-down to arrange issues sequentially. Issues can be sorted by date created, date updated, and issue ID in ascending or descending order. |
| 101 | +Filters can be assigned from the **Filters** dropdown available on the left-hand side of the Intake page. Issues can be filtered by *Issue status*, *State*, *Priority*, *Assignee*, *Created by*, *Labels*, *Created date*, and *Last updated date*. |
97 | 102 |
|
98 | | -<video controls> |
99 | | - <source src="/images/inbox/Filter and sorting in Inbox issues.mp4" type="video/mp4"/> |
100 | | -</video> |
| 103 | +Next to the Filters dropdown, you can use the sort drop-down to arrange Intake issues sequentially. Issues can be sorted by *Date created*, *Date updated*, and *ID* in ascending or descending order. |
101 | 104 |
|
102 | 105 | ## Additional features |
103 | 106 |
|
104 | | -- Inbox issue description just like the project issue description has a rich text editor that allows you to format text, attach pictures, links and files, or add tables and dividers. |
| 107 | +- Intake issue description has a rich text editor that allows you to format text, attach pictures, links and files, or add tables and dividers. |
105 | 108 | <Frame> |
106 | 109 | <img src="/images/inbox/inbox-description-box.png" /> |
107 | 110 | </Frame> |
108 | | -- Inbox has an activity and comments tab to know the status and collect feedback from users and customers. |
109 | | - |
110 | | - **Activity tab** |
111 | | - |
112 | | - All the changes made to the issue can be tracked in real time from the activity tab. |
| 111 | +- Intake has an activity and comments section to know the status and see feedback from users and customers. All the changes made to the issue can be tracked in real-time under the **Activity** section. |
113 | 112 | <Frame> |
114 | 113 | <img src="/images/inbox/inbox-activity.png" /> |
115 | 114 | </Frame> |
116 | | - **Comments** |
117 | | - |
118 | | - - Private and public comments |
119 | | - |
120 | | - - Private and public comments will enable you to communicate internally and externally. Comments can be made private and public at the time of creation. A private comment can be made public after it has been posted and vice-versa from the ellipses menu. |
121 | | - <Frame> |
122 | | - <img src="/images/inbox/inbox-comments.png" /> |
123 | | - </Frame> |
124 | | - - Rich text editor, reactions, and mentions |
125 | | - |
126 | | - - The comment section has a rich text editor (just like the issue description), reactions with emojis, and mentions your teammates to communicate. |
127 | | - <Frame> |
128 | | - <img src="/images/inbox/RTE-reactions-and-mentions.png" /> |
129 | | - </Frame> |
130 | | -- You can review your pending requests in Inbox sequentially using 🔼 or 🔽 button. |
| 115 | +- The **Add Comment** box has a rich text editor where you can react with emojis and mention your teammates to communicate. |
| 116 | + <Frame> |
| 117 | + <img src="/images/inbox/RTE-reactions-and-mentions.png" /> |
| 118 | + </Frame> |
| 119 | +- You can review pending requests in Intake sequentially using 🔼 or 🔽 button. |
131 | 120 | <Frame> |
132 | 121 | <img src="/images/inbox/inbox-navigate.png" /> |
133 | 122 | </Frame> |
0 commit comments