-
Notifications
You must be signed in to change notification settings - Fork 38
Custom relations #423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Custom relations #423
Changes from all commits
b1511eb
6618c00
77a888c
6813a19
b6bd326
86521f8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,54 @@ | ||||||
| --- | ||||||
| title: Define relation types for work items | ||||||
| description: Define custom relation types at the workspace level to represent how work items connect across your projects. | ||||||
| --- | ||||||
|
|
||||||
| # Custom relations <Badge type="warning" text="Enterprise Grid" /> | ||||||
|
|
||||||
| Relations describe how work items are connected to each other. | ||||||
|
|
||||||
| Plane includes three [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints. | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct the count of default relation types. The text claims "three [default relation types]" but according to the linked documentation in
📝 Proposed fix-Plane includes three [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
+Plane includes four [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
|
|
||||||
| Custom relations are workspace-level configurations. Once created, they're available when linking work items across any project in the workspace. | ||||||
|
|
||||||
| ## Create a custom relation | ||||||
|
|
||||||
| > **Role**: Workspace Admin | ||||||
|
|
||||||
| 1. Go to **Workspace Settings > Relations**. | ||||||
| 2. Click **Add relation**. | ||||||
| 3. Fill in the three fields: | ||||||
| - **Title** — the name of the relation type. | ||||||
| - **Inward name** — how the relation reads from the perspective of the work item you're adding it to (e.g., "blocking," "depended on by," "tested by"). | ||||||
| - **Outward name** — how the relation reads from the perspective of the work item you're linking to (e.g., "blocked by," "depends on," "tests"). | ||||||
| 4. Click **Save**. | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| The directional naming ensures the relation reads correctly from either side. The inward name appears on the work item you're adding the relation to, and the outward name appears on the work item you're linking. | ||||||
|
|
||||||
| ### Examples | ||||||
|
|
||||||
| | Title | Inward name | Outward name | | ||||||
| | --------- | ----------- | ------------ | | ||||||
| | Tests | tested by | tests | | ||||||
| | Caused by | caused | caused by | | ||||||
|
|
||||||
| ## Edit or delete a custom relation | ||||||
|
|
||||||
| > **Role**: Workspace Admin | ||||||
|
|
||||||
| From **Workspace Settings > Relations**, click on any custom relation to update its title, inward name, or outward name. You can also delete custom relations you no longer need. | ||||||
|
|
||||||
| Changes apply across the workspace and update how the relation appears on any work items that already use it. | ||||||
|
|
||||||
| ## Use relations in work items | ||||||
|
|
||||||
| Once a custom relation exists, any project member can use it when linking work items. | ||||||
|
|
||||||
| 1. Open a work item. | ||||||
| 2. Click **Add relation**. | ||||||
| 3. Choose the relation type from the dropdown — both default and custom relations appear here. | ||||||
| 4. Select the work item to link. | ||||||
|
|
||||||
| The relation appears on both work items using the appropriate inward or outward label. Learn more about [adding relations to work items](/core-concepts/issues/overview#add-relations). | ||||||
Uh oh!
There was an error while loading. Please reload this page.