Skip to content

Commit 5a73097

Browse files
DanciaDancia
authored andcommitted
added new page issue types
1 parent f0101ff commit 5a73097

File tree

10 files changed

+103
-1
lines changed

10 files changed

+103
-1
lines changed
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Add, configure and control your issue types
3+
sidebarTitle: Issue Types
4+
description: Issue Types unlock a whole new way of adding, editing, and moving work forward in Plane.
5+
6+
---
7+
8+
## Overview
9+
10+
The default issue type called `Issue` is great for starting with Plane, but as you advance in your project management journey, you find the need for names and properties unique to the type of work you are doing.
11+
12+
For example, your Marketing team may need an issue type called `Content` with the properties, `Channel`, `SEO done?`, and `Reviewer` β€” properties that aren't available on the default Issues. Your Engineering team, on the other hand, may want an issue type called `Bugs` with the properties `Version` and `Environment` to have more upfront info per bug reported.
13+
14+
Issue Types make these and infinite other use cases possible.
15+
16+
## Create your issue type
17+
18+
**Plan**: Pro
19+
**Role**: Project admins
20+
21+
1. Click the three-dots icon next to your project name on the left pane and click **Settings**.
22+
2. Select **Issue Types** on the right pane.
23+
<Frame>![Create issue](/images/issues/setup-issue-types.webp)</Frame>
24+
3. Click the **Enable** button to start creating issue types for your project.
25+
<Frame>![Create issue](/images/issues/enable-issue-types.webp)</Frame>
26+
4. The default type is called `Issue`. Click the **Add Issue Type** button to create a new issue type.
27+
<Frame>![Create issue](/images/issues/add-issue-type.webp)</Frame>
28+
5. In the **Create issue type** modal, type name, and description, and choose a background color and an icon to represent the issue type. Click the **Create issue type** button.
29+
<Frame>![Create issue](/images/issues/create-issue-type.webp)</Frame>
30+
6. Switch on the toggle button to allow users to select the issue type when creating issues and sub-issues.
31+
<Frame>![Create issue](/images/issues/activate-issue-type.webp)</Frame>
32+
33+
### Examples of issue types
34+
35+
- *IT development teams*
36+
`Bug` `Improvement` `Epic` `Story`
37+
38+
39+
- *IT support teams*
40+
`Incident` `Change` `Service request` `New feature`
41+
42+
- *Product management*
43+
`Product launches` `User research` `Feature development` `Market analysis`
44+
45+
- *Production units (automobile)*
46+
`Production planning`, `Material procurement`, `Quality control`, `Inventory management`
47+
48+
- *Design agencies*
49+
`Revision requests` `Design drafting` `Client presentation` `Quality assurance`
50+
51+
- *NGOs*
52+
`Grant writing` `Volunteer coordination` `Beneficiary management`
53+
54+
55+
## Add custom properties
56+
57+
Adding custom properties to the default issue type Issue and other newly created issue types is possible.
58+
59+
1. Under the issue type, click **Add New Property** to create custom fields.
60+
<Frame>![Create issue](/images/issues/add-new-property.webp)</Frame>
61+
2. Specify values for **Name**, **Type** and **Attributes** of the new property. Select the **Mandatory** checkbox if it's a required field. Switch on the **Active** toggle button to make the property visible in issues.
62+
<Frame>![Create issue](/images/issues/property-details.webp)</Frame>
63+
3. Click the **Confirm** (green checkmark icon) to add the property to the issue type.
64+
65+
<Warning>Before you delete properties, switch off the **Active** toggle button to avoid data loss.</Warning>
66+
67+
### Property types
68+
69+
Here's a list of all the property types and attributes that Plane provides for creating custom fields:
70+
71+
| Property type | Attributes | Notes|
72+
| --------------| ------------------- |---- |
73+
| **Text** | Single line, Paragraph, Read-only | The **Read-only** attribute cannot be marked as mandatory. Enter text in the Read only data box for this option.|
74+
| **Number** | Default value | An optional default value can be given to this property type.|
75+
| **Dropdown** | Single select, Multi select, Add options | Specify the values for the dropdown under **Add options**. |
76+
| **Boolean** | True/False | Default value is false. This attribute cannot be marked as mandatory. |
77+
| **Date** | Date Format | Consistent date format across all properties. |
78+
| **Member picker** | Single Select, Multi select | Displays a list of all project members. |
79+
80+
81+
### Examples of custom properties
82+
83+
- *Product launch*
84+
`Launch date` `Geography` `Budget` `Approval status` `Stakeholder`
85+
86+
- *Bug*
87+
`Affected version` `Resolved version` `Environment` `Steps to reproduce` `Approval status` `Customer impact`
88+
89+
- *Final design approval*
90+
`Final design files` `Approval checklist` `Client approval date` `Responsible person`
91+
92+
## Use issue types
93+
94+
Once the project Admin sets up the issue types any project member can use them when creating issues or sub-issues.
95+
96+
- In the **Create new issue** modal, the user can choose the desired issue type from the list at the top left corner. By default, the issue type `Issue` is selected displaying both system-defined and custom properties.
97+
- Changing the issue type will update the modal to display the relevant properties for that type.
98+
- The system ensures that all properties marked as mandatory are filled before creating the issue.
99+
<Frame>![Create issue](/images/issues/use-issue-type.webp)</Frame>
100+
101+
When viewing issues, the issue type is displayed with an icon near the title for easy identification. Any custom properties added will also appear in the list of properties, and changes to these values are tracked in the issue's activity trail.
36.8 KB
Loading
25.9 KB
Loading
22.3 KB
Loading
22.6 KB
Loading
37.9 KB
Loading
37.6 KB
Loading
26.3 KB
Loading
30.9 KB
Loading

β€Žmint.jsonβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@
107107
"pages":[
108108
"core-concepts/issues/overview",
109109
"core-concepts/issues/properties",
110-
"core-concepts/issues/visualise_filter"
110+
"core-concepts/issues/visualise_filter",
111+
"core-concepts/issues/issue-types"
111112
]
112113
},
113114
"core-concepts/cycles",

0 commit comments

Comments
Β (0)