diff --git a/core-concepts/deploy.mdx b/core-concepts/deploy.mdx index cc8f5b27..66744c1e 100644 --- a/core-concepts/deploy.mdx +++ b/core-concepts/deploy.mdx @@ -1,6 +1,6 @@ --- -sidebarTitle: Deploy -title: Plane Deploy +sidebarTitle: Publish +title: Plane Publish --- Any project you build in Plane can be turned into a public page, creating a fully navigable website. This feature will make it easier for your users and customers know what features you’re on or when bug fixes are rolling out. No sign-up's required. diff --git a/core-concepts/inbox.mdx b/core-concepts/inbox.mdx new file mode 100644 index 00000000..0182ee19 --- /dev/null +++ b/core-concepts/inbox.mdx @@ -0,0 +1,133 @@ +--- +title: Inbox +--- + +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. + +## Create Issue in Inbox + +Users with guest and above roles can create issues in the Inbox. To create an issue, + +- Head to Inbox from the project sidebar. +- Click on the ‘Add Issue’ button at the top right corner. +- Enter all the details that apply. Issue title, description, and properties. + +## Properties in an Inbox issue + +For an issue in the inbox, you can choose to assign the following properties, + +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. +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 +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. +4. Due dates - You can also track when the issue needs to be prioritized or triaged by adding due dates. +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. + +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. + + + +## Action for an Inbox issue + +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. + +- Accepting an Issue + + 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. + +- Declining an Issue + + 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. + +- Snoozing an Issue + + An issue can be snoozed to review it at a later time. Steps to snooze an issue: + + 1. Open a pending issue + 2. Hover over to the ellipses in the top right corner + 3. Select snooze option + 4. Select a date + + The issue is now snoozed and can be accessed from the filters drop-down. + + + +- Marking an issue as Duplicate: + + In cases where a similar issue exists in your project, an inbox issue can be marked as duplicate. + + Steps to mark an issue as duplicate: + + 1. Open a pending issue + 2. Hover over to the ellipses in the top right corner + 3. Select mark as duplicate option + 4. Select an issue of which the current issue is the duplicate + + The issue is now declined with a ‘duplicate’ label on it. + + + + +## Open and closed issues + +You can view Open or closed issues on the Inbox sidebar. + +‘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. + + + +## Sorting and Filtering + +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. + +**Filtering inbox issues** + +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. + +**Sorting inbox issues** + +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. + + + +## Additional features + +- 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. + + + +- Inbox has an activity and comments tab to know the status and collect feedback from users and customers. + + **Activity tab** + + All the changes made to the issue can be tracked in real time from the activity tab. + + + + **Comments** + + - Private and public comments + + - 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. + + + + - Rich text editor, reactions, and mentions + + - The comment section has a rich text editor (just like the issue description), reactions with emojis, and mentions your teammates to communicate. + + + +- You can review your pending requests in Inbox sequentially using 🔼 or 🔽 button. + + + \ No newline at end of file diff --git a/core-concepts/issues/overview.mdx b/core-concepts/issues/overview.mdx index dbbc1b85..c4a2688e 100644 --- a/core-concepts/issues/overview.mdx +++ b/core-concepts/issues/overview.mdx @@ -45,41 +45,6 @@ After creating an issue, you have the option to add sub-issues to it either by c ![sub-issues](/images/issues/issue-sub-issues.png) - -## Visualise and filter issues - -In Plane, you have several options for visualizing and filtering issues to help you quickly analyze and investigate them. - -### Layouts - -- **List View:** Displays issues as an ordered list. Supports grouping by specific issue properties for easy categorization. - ![issue-list](/images/issues/issue-list-layout.png) -- **Kanban View:** Groups issues by a specific property in a Kanban board format, typically by issue states. Allows for quick assessment of issues' status. - ![issue-kanban](/images/issues/issue-kanban-layout.png) -- **Calendar View:** Groups issues by due dates in a calendar interface, facilitating quick identification of issues due soon. - ![issue-calendar](/images/issues/issue-calendar-layout.png) -- **Spreadsheet View:** Arranges issues as rows in a spreadsheet, with all properties available as columns. Useful for taking similar actions on multiple issues. - ![issue-spreadsheet-layout](/images/issues/issue-spreadsheet-layout.png) -- **Gantt View:** Arranges issues by start and due dates in a Gantt chart format, providing a visual representation of issue timelines. - ![issue-gantt](/images/issues/issue-gantt-layout.png) - -### Filter Issues - -Issues can be filtered by various properties, including: - - 1. Priority - 2. State - 3. Start date - 4. Due date - 5. Assignee - 6. Labels - 7. Modules - 8. Cycles - 9. Created by -10. Mentions - -When applying multiple filters, only issues matching all filter criteria are displayed. Note that when filtering issues in a workspace view, filtering by state, cycles, or modules is not yet supported. - ## Remove Issues Issues can be removed in two ways: diff --git a/core-concepts/issues/visualise_filter.mdx b/core-concepts/issues/visualise_filter.mdx new file mode 100644 index 00000000..3f17cb6f --- /dev/null +++ b/core-concepts/issues/visualise_filter.mdx @@ -0,0 +1,35 @@ +--- +title: Visualise and filter issues +--- + +In Plane, you have several options for visualizing and filtering issues to help you quickly analyze and investigate them. + +### Layouts + +- **List View:** Displays issues as an ordered list. Supports grouping by specific issue properties for easy categorization. + ![issue-list](/images/issues/issue-list-layout.png) +- **Kanban View:** Groups issues by a specific property in a Kanban board format, typically by issue states. Allows for quick assessment of issues' status. + ![issue-kanban](/images/issues/issue-kanban-layout.png) +- **Calendar View:** Groups issues by due dates in a calendar interface, facilitating quick identification of issues due soon. + ![issue-calendar](/images/issues/issue-calendar-layout.png) +- **Spreadsheet View:** Arranges issues as rows in a spreadsheet, with all properties available as columns. Useful for taking similar actions on multiple issues. + ![issue-spreadsheet-layout](/images/issues/issue-spreadsheet-layout.png) +- **Gantt View:** Arranges issues by start and due dates in a Gantt chart format, providing a visual representation of issue timelines. + ![issue-gantt](/images/issues/issue-gantt-layout.png) + +### Filter Issues + +Issues can be filtered by various properties, including: + + 1. Priority + 2. State + 3. Start date + 4. Due date + 5. Assignee + 6. Labels + 7. Modules + 8. Cycles + 9. Created by +10. Mentions + +When applying multiple filters, only issues matching all filter criteria are displayed. Note that when filtering issues in a workspace view, filtering by state, cycles, or modules is not yet supported. diff --git a/images/inbox/Accept inbox issue.mp4 b/images/inbox/Accept inbox issue.mp4 new file mode 100644 index 00000000..4d8a1678 Binary files /dev/null and b/images/inbox/Accept inbox issue.mp4 differ diff --git a/images/inbox/Create issue in Inbox.mp4 b/images/inbox/Create issue in Inbox.mp4 new file mode 100644 index 00000000..ce4e9e52 Binary files /dev/null and b/images/inbox/Create issue in Inbox.mp4 differ diff --git a/images/inbox/Declining inbox issue.mp4 b/images/inbox/Declining inbox issue.mp4 new file mode 100644 index 00000000..55c2f74c Binary files /dev/null and b/images/inbox/Declining inbox issue.mp4 differ diff --git a/images/inbox/Enable Inbox feature.mp4 b/images/inbox/Enable Inbox feature.mp4 new file mode 100644 index 00000000..382cb783 Binary files /dev/null and b/images/inbox/Enable Inbox feature.mp4 differ diff --git a/images/inbox/Filter and sorting in Inbox issues.mp4 b/images/inbox/Filter and sorting in Inbox issues.mp4 new file mode 100644 index 00000000..1c93e4d0 Binary files /dev/null and b/images/inbox/Filter and sorting in Inbox issues.mp4 differ diff --git a/images/inbox/RTE-reactions-and-mentions.png b/images/inbox/RTE-reactions-and-mentions.png new file mode 100644 index 00000000..48fdb181 Binary files /dev/null and b/images/inbox/RTE-reactions-and-mentions.png differ diff --git a/images/inbox/inbox-activity.png b/images/inbox/inbox-activity.png new file mode 100644 index 00000000..89973f68 Binary files /dev/null and b/images/inbox/inbox-activity.png differ diff --git a/images/inbox/inbox-comments.png b/images/inbox/inbox-comments.png new file mode 100644 index 00000000..9cf88f48 Binary files /dev/null and b/images/inbox/inbox-comments.png differ diff --git a/images/inbox/inbox-description-box.png b/images/inbox/inbox-description-box.png new file mode 100644 index 00000000..94b447a1 Binary files /dev/null and b/images/inbox/inbox-description-box.png differ diff --git a/images/inbox/inbox-navigate.png b/images/inbox/inbox-navigate.png new file mode 100644 index 00000000..ab0b837a Binary files /dev/null and b/images/inbox/inbox-navigate.png differ diff --git a/images/inbox/inbox-properties.png b/images/inbox/inbox-properties.png new file mode 100644 index 00000000..2ff2fb2b Binary files /dev/null and b/images/inbox/inbox-properties.png differ diff --git a/images/inbox/inbox-tabs.png b/images/inbox/inbox-tabs.png new file mode 100644 index 00000000..c61d1ad5 Binary files /dev/null and b/images/inbox/inbox-tabs.png differ diff --git a/images/inbox/mark-as-duplicate.png b/images/inbox/mark-as-duplicate.png new file mode 100644 index 00000000..cc4ce35f Binary files /dev/null and b/images/inbox/mark-as-duplicate.png differ diff --git a/images/inbox/snooze-issue.png b/images/inbox/snooze-issue.png new file mode 100644 index 00000000..1a562031 Binary files /dev/null and b/images/inbox/snooze-issue.png differ diff --git a/mint.json b/mint.json index 976f4a34..efa574f9 100644 --- a/mint.json +++ b/mint.json @@ -22,7 +22,7 @@ }, "topbarCtaButton": { "name": "Sign in", - "url": "https://app.plane.so/" + "url": "https://app.plane.so/sign-in" }, "anchors": [ { @@ -102,7 +102,8 @@ "group":"Issues", "pages":[ "core-concepts/issues/overview", - "core-concepts/issues/properties" + "core-concepts/issues/properties", + "core-concepts/issues/visualise_filter" ] }, "core-concepts/cycles", @@ -115,6 +116,7 @@ "core-concepts/pages/editor-blocks" ] }, + "core-concepts/inbox", "core-concepts/analytics", "core-concepts/deploy", "core-concepts/power-k"