Tabs, new widgets, Jira updates and more#477
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThe PR updates documentation for automations, Plane Query Language, page editor Tabs, dashboard widgets, and Jira importing, including new capabilities, configuration details, usage guidance, and operational behavior. ChangesAutomation documentation
Plane Query Language documentation
Page editor documentation
Dashboard documentation
Jira importer documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/automations/custom-automations.md`:
- Around line 167-170: Update the cycle action description and its accompanying
tip in the custom automations documentation to match the actual behavior: do not
claim automation can move a work item between cycles unless a supported transfer
flow is documented. Describe only the supported cycle assignment/removal
behavior and preserve the single-cycle constraint.
In `@docs/core-concepts/issues/plane-query-language.md`:
- Around line 63-65: Update every fenced PQL example in the document, including
the blocks containing NOT hasNoAssignee(), the priority/state query, the ORDER
BY query, and blockedBy("PROJ-42"), to specify text or the repository-supported
PQL language identifier immediately after each opening fence. Ensure all
affected fences satisfy Markdownlint MD040.
In `@docs/dashboards.md`:
- Line 238: Update the “Two dimensional table” heading to use the canonical
“table chart” widget name and hyphenate the modifier as “Two-dimensional,”
matching the surrounding documentation.
- Around line 299-302: Update the “Columns to display” list in the work-item
dashboard documentation to use the canonical Work items table labels: “Work item
type,” “Estimate points,” “Sub-work items,” and “Customers,” while leaving the
remaining column names unchanged.
- Around line 221-230: The work items statistics description at
docs/dashboards.md:221-230 must say each group displays the selected metric or
metrics, rather than always describing totals or counts. Update the completion
measure description at docs/dashboards.md:316-320 to support both work item
counts and estimate points, while preserving the existing grouping and metric
configuration guidance.
In `@docs/importers/jira.md`:
- Line 6: Update the H1 heading in the Jira importer documentation to exactly
match the sidebar label “Jira” configured in docs/.vitepress/config.ts, changing
“Jira importer” to “Jira”.
- Around line 42-46: Update the Jira import instructions around “Configure Jira”
to explicitly describe the selection required for Jira Server and Data Center
after connecting, while retaining the existing Cloud site and project guidance.
Clarify the deployment-specific configuration without changing the remaining
import steps.
- Around line 68-80: Reconcile the feature naming and scope across the “Issue
types and work item types” callout and the “What gets imported” table. Use one
canonical feature name consistently, explicitly identify any alias only if
needed, and ensure the paid-feature prerequisite and project/workspace creation
scope match throughout.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: a0b033b7-eab6-475f-b538-18b6eaf49179
📒 Files selected for processing (5)
docs/automations/custom-automations.mddocs/core-concepts/issues/plane-query-language.mddocs/core-concepts/pages/editor-blocks.mddocs/dashboards.mddocs/importers/jira.md
| | Cycle | Assign the work item to a cycle, move it to a different cycle, or remove it from its current cycle | | ||
|
|
||
| :::tip | ||
| When assigning a cycle, the cycle must belong to the work item's own project, and you cannot assign a work item to a cycle that has already ended. A work item can be in only one cycle at a time, so assigning a cycle moves the work item off any cycle it is currently in. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== files ==\n'
git ls-files 'docs/automations/custom-automations.md' 'docs/core-concepts/cycles.md' 'docs/.vitepress/config.ts'
printf '\n== relevant ranges: custom automations ==\n'
sed -n '150,185p' docs/automations/custom-automations.md
printf '\n== relevant ranges: cycles ==\n'
sed -n '100,140p' docs/core-concepts/cycles.mdRepository: makeplane/docs
Length of output: 5140
Update the cycle action description docs/automations/custom-automations.md:167-170
The table/tip says automation can move a work item to a different cycle, but the cycles docs say a work item can only belong to one cycle and adding it to another is blocked. Reword this to match the actual behavior, or document a separate transfer flow if one exists.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/automations/custom-automations.md` around lines 167 - 170, Update the
cycle action description and its accompanying tip in the custom automations
documentation to match the actual behavior: do not claim automation can move a
work item between cycles unless a supported transfer flow is documented.
Describe only the supported cycle assignment/removal behavior and preserve the
single-cycle constraint.
| ``` | ||
| NOT hasNoAssignee() | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add language identifiers to the fenced PQL examples.
These new code fences trigger Markdownlint MD040. Use a language such as text (or the repository’s supported PQL language identifier) after each opening fence.
Proposed fix
-```
+```text
NOT hasNoAssignee()- +text
(priority = High AND state in (Backlog, In Progress, Todo)) OR ...
-```
+```text
priority = High ORDER BY dueDate ASC LIMIT 20
- +text
blockedBy("PROJ-42")
</details>
Also applies to: 71-73, 79-81, 428-430
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.23.0)</summary>
[warning] 63-63: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @docs/core-concepts/issues/plane-query-language.md around lines 63 - 65,
Update every fenced PQL example in the document, including the blocks containing
NOT hasNoAssignee(), the priority/state query, the ORDER BY query, and
blockedBy("PROJ-42"), to specify text or the repository-supported PQL language
identifier immediately after each opening fence. Ensure all affected fences
satisfy Markdownlint MD040.
</details>
<!-- fingerprinting:phantom:triton:luna -->
<!-- cr-indicator-types:potential_issue -->
<!-- cr-comment:v1:3b4af3a14693009eb5397885 -->
_Source: Linters/SAST tools_
<!-- This is an auto-generated comment by CodeRabbit -->
| The work items statistics widget groups work items by a dimension you choose and shows the total for each group. Grouping by assignee gives a "work items by assignee" view, showing how work is distributed across your team. | ||
|
|
||
| It is most useful for workload and distribution questions: how many work items each person has, how work splits across states or priorities, or how it spreads across projects. | ||
|
|
||
| **Basic** | ||
|
|
||
| Configure the widget with: | ||
|
|
||
| - **Group by** - the dimension to group work items by: State, State group, Project, **Assignee**, Label, Work item type, Cycle, Module, Created by, or Priority. | ||
| - **Metric** - **Work item count**, **Estimate points**, or both. The first selected metric is the primary one. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make widget descriptions reflect the configured metric.
Both sections describe count-based output even though estimate points can be selected:
docs/dashboards.md#L221-L230: state that each group displays the selected metric(s), not always a total.docs/dashboards.md#L316-L320: describe a completion value/measure that supports both counts and estimate points.
📍 Affects 1 file
docs/dashboards.md#L221-L230(this comment)docs/dashboards.md#L316-L320
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dashboards.md` around lines 221 - 230, The work items statistics
description at docs/dashboards.md:221-230 must say each group displays the
selected metric or metrics, rather than always describing totals or counts.
Update the completion measure description at docs/dashboards.md:316-320 to
support both work item counts and estimate points, while preserving the existing
grouping and metric configuration guidance.
| - **Show percentage** - display each group's share of the total. | ||
| - **Progress bar color** - the color of the group bars. | ||
|
|
||
| ### Two dimensional table |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep the widget name consistent with the surrounding text.
The new heading says “Two dimensional table,” while the body still calls the widget a “table chart.” Use one canonical name throughout and hyphenate the compound modifier as “Two-dimensional.”
🧰 Tools
🪛 LanguageTool
[grammar] ~238-~238: Use a hyphen to join words.
Context: ... - the color of the group bars. ### Two dimensional table A table chart renders...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dashboards.md` at line 238, Update the “Two dimensional table” heading
to use the canonical “table chart” widget name and hyphenate the modifier as
“Two-dimensional,” matching the surrounding documentation.
Source: Linters/SAST tools
| Rows display each work item assigned to you, with the identifier and title always visible. It is configured exactly like the work items table: | ||
|
|
||
| - **Columns to display** - choose which additional columns appear. The available columns are State, Priority, Assignees, Due date, Start date, Labels, Cycle, Modules, Type, Estimate, Created by, Releases, Sub work items, Attachments, Links, Customer requests, and Customer. New widgets start with State, Priority, and Due date. | ||
| - **Max rows** - the number of rows per page, between 1 and 100 (default 10). Use the pagination control to move through pages. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align column labels with the Work items table section.
The available-column names differ from the preceding table: Type vs Work item type, Estimate vs Estimate points, Sub work items vs Sub-work items, and Customer vs Customers. Reuse the canonical labels to avoid configuration confusion.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dashboards.md` around lines 299 - 302, Update the “Columns to display”
list in the work-item dashboard documentation to use the canonical Work items
table labels: “Work item type,” “Estimate points,” “Sub-work items,” and
“Customers,” while leaving the remaining column names unchanged.
| --- | ||
|
|
||
| # Jira importer (Cloud, Server, and Data Center) | ||
| # Jira importer |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Align the H1 with the sidebar label.
docs/.vitepress/config.ts labels this page Jira, while the H1 is Jira importer. Update either the heading or sidebar entry so they match.
As per coding guidelines, page headings (#) must match the sidebar label defined in docs/.vitepress/config.ts.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/importers/jira.md` at line 6, Update the H1 heading in the Jira importer
documentation to exactly match the sidebar label “Jira” configured in
docs/.vitepress/config.ts, changing “Jira importer” to “Jira”.
Source: Coding guidelines
1 participant
Admin
Workspace Audit Logs Phase -1 Track key actions across the workspace with a dedicated audit log section.
WIKI
Composition Tabs Add horizontal and vertical tabs directly within the editor for better content organization. This can be invoked using
/tabsand choosing Horizontal or Vertical Tabs.Dashboard Widgets
Cycle Progress Bar New dashboard widget showing cycle progress at a glance.
Work Item Type Progress New dashboard widget showing progress broken down by work item type.
Work Items assigned to me New dashboard widget showing work items by assignee.
Cycles
Automations Enhancements Automations can now assign work items to a cycle via change_property.
PQL & Search
Added support for ‘text’ component in PQL, searches through both Title and Description of work items.
Importers
Jira Server Attachment Downloads Uses a custom script runner endpoint for downloading Jira Server attachments. Please add custom REST endpoint using this instructions to import attachments - https://sites.plane.so/pages/4cfee57ef84d4b50bacfb110e37316e5
Summary by CodeRabbit