diff --git a/docs/ai/pi-chat.mdx b/docs/ai/pi-chat.mdx index 986f7b5..0bb2281 100644 --- a/docs/ai/pi-chat.mdx +++ b/docs/ai/pi-chat.mdx @@ -63,7 +63,7 @@ Plane AI is accessible from the left sidebar (AI icon for a dedicated chat inter 1. Type your question in the chat input at the bottom of the Plane AI interface. 2. Plane AI will process your query and provide a response. 3. You can ask follow-up questions to dive deeper into the results. -4. Use `@mentions` for direct entity reference, for eg., "@WEB-4651 what's the status of this issue?" +4. Use `@mentions` for direct entity reference, for eg., "@WEB-4651 what's the status of this work item?" ![Plane AI chat mentions](https://media.docs.plane.so/pi-chat/pi-chat-mentions.webp#hero) @@ -99,7 +99,7 @@ Plane AI can create work items, projects, cycles, and modules through natural la The newly created work item will include: - Automatically generated title based on your description -- AI-generated description summarizing the issue +- AI-generated description summarizing the work item - Appropriate work item type (bug, feature, etc.) inferred from your command - Default project properties diff --git a/docs/automations/custom-automations.mdx b/docs/automations/custom-automations.mdx index 162137d..a4b684d 100644 --- a/docs/automations/custom-automations.mdx +++ b/docs/automations/custom-automations.mdx @@ -1,7 +1,7 @@ --- title: Automations hide_title: true -description: Automate repetitive project tasks with trigger-based workflows. Set up rules to automatically update issue properties, assign team members, and manage priorities when specific conditions are met. +description: Automate repetitive project tasks with trigger-based workflows. Set up rules to automatically update work item properties, assign team members, and manage priorities when specific conditions are met. --- import Tags from "@site/src/components/Tags"; @@ -13,7 +13,7 @@ import Tags from "@site/src/components/Tags"; Automations let you streamline your project management workflow by automatically performing actions based on specific triggers and conditions. This powerful feature eliminates repetitive manual tasks, ensures consistency in your processes, and helps your team maintain focus on high-value work by letting the system handle routine operations. -Think of automations as your digital assistant that watches for specific events in your projects and responds according to rules you define. Whether it's updating issue statuses, assigning team members, adding labels, or posting comments, automations work behind the scenes to keep your projects moving smoothly. +Think of automations as your digital assistant that watches for specific events in your projects and responds according to rules you define. Whether it's updating work item statuses, assigning team members, adding labels, or posting comments, automations work behind the scenes to keep your projects moving smoothly. ![Create automations](https://media.docs.plane.so/automations/create-automation.webp#hero) @@ -104,13 +104,13 @@ Toggle automations on or off as needed without deleting them. This is useful for Automatically transition work items between workflow states and update status when specific conditions are met. - **Team assignment and handoffs** -Automatically assign team members when issues reach specific stages, reassign work based on type or priority, and ensure proper handoffs between different teams or departments. +Automatically assign team members when work items reach specific stages, reassign work based on type or priority, and ensure proper handoffs between different teams or departments. - **Priority and categorization** -Auto-adjust issue priorities based on labels or assignees, apply consistent labeling across similar issue types, and maintain project organization through automated property updates. +Auto-adjust work item priorities based on labels or assignees, apply consistent labeling across similar work item types, and maintain project organization through automated property updates. - **Communication and notifications** -Post automatic comments when issues are assigned or reassigned, add context when issues move between stages, and ensure stakeholders receive updates on critical changes. +Post automatic comments when work items are assigned or reassigned, add context when work items move between stages, and ensure stakeholders receive updates on critical changes. --- Automations transform reactive project management into proactive workflow orchestration, allowing teams to focus on solving problems rather than managing processes. With the ability to monitor, edit, and control when automations run, you maintain full control over your automated workflows while reducing manual overhead. \ No newline at end of file diff --git a/docs/core-concepts/cycles.mdx b/docs/core-concepts/cycles.mdx index 12cdddf..e75c208 100644 --- a/docs/core-concepts/cycles.mdx +++ b/docs/core-concepts/cycles.mdx @@ -7,7 +7,7 @@ import Tags from "@site/src/components/Tags"; # Manage and track your sprints using Cycles -A Cycle is a set period of time where your team focuses on completing specific tasks or issues, similar to sprints in Agile. Each Cycle is flexible, allowing you to prioritize and tackle backlog items at your own pace. +A Cycle is a set period of time where your team focuses on completing specific tasks or work items, similar to sprints in Agile. Each Cycle is flexible, allowing you to prioritize and tackle backlog items at your own pace. Using Cycles, your team stays organized, meets deadlines, and keeps moving forward efficiently. It’s all about getting things done without the overwhelm! @@ -92,6 +92,42 @@ Once the due date of an active Cycle passes, it’s automatically marked as comp ![Transfer work items](https://media.docs.plane.so/cycles/transfer-issues.webp#hero-tr) + +
+ ## Auto-schedule cycles + +
+ +Automate the creation and management of cycles according to predefined configurations, eliminating manual setup while ensuring consistent cycle planning and team predictability. + +![Autoschedule cycles](https://media.docs.plane.so/cycles/auto-schedule-cycles.webp#hero-br) + +### Benefits +- Maintain regular cycle rhythms automatically without manual intervention. +- Keep future cycles pre-scheduled so teams can plan ahead with confidence. +- Eliminate repetitive administrative work from cycle creation. +- Ensure reliable, consistent sprint schedules across projects. + +### Configuration + +1. Navigate to **Project Settings → Features → Cycles**. +2. Turn on the **Auto-schedule cycles** toggle and configure: + - Cycle Title — Set a naming convention for automatically created cycles. + - Cycle Duration — Define the length of each cycle in weeks (e.g., 1 week, 2 weeks). + - Cooldown Period — Add an optional buffer between cycles in days for planning and retrospectives. + - Cycle starts day — Choose the start date for the first auto-scheduled cycle. + - Number of future cycles — Specify how many upcoming cycles to keep pre-scheduled. + - Auto-rollover work items — Enable to automatically move incomplete work items from one cycle to the next. + +Once enabled, the system automatically: + +- Generates the configured number of future cycles based on your settings. +- Creates a new cycle when the current one concludes to maintain the specified schedule. +- Ensures cycles don't overlap and follow the defined cadence. +- Applies consistent naming conventions and durations across all cycles. + +All auto-scheduled cycles appear in your Cycles view with clear dates and durations. Admins can update configuration settings anytime to adjust the schedule, and the system will adapt future cycles accordingly. + ## Track active cycle Once a cycle is active and contains work items, you can monitor its progress, assess the team's productivity, and review the breakdown of priorities in the Cycles page of the project. This section also allows you to investigate any discrepancies if the cycle is not proceeding as expected. @@ -109,22 +145,22 @@ This feature provides powerful visualization tools to help you track project cyc ### Cycle summary -At the top of the cycle view, you’ll see the overall progress percentage. Hover over it to get a breakdown of completed and pending issues, along with the number of days left in the cycle. +At the top of the cycle view, you’ll see the overall progress percentage. Hover over it to get a breakdown of completed and pending work items, along with the number of days left in the cycle. To the left, there’s a color-coded summary that shows if the cycle is leading or trailing based on the burn-down and build-up. This gives you instant feedback about how things are going and highlights risks so you can make quick decisions and ensure nothing slips through the cracks. -The burn-down and build-up charts are straightforward ways to gauge your cycle’s momentum. You can customize them to show progress based on the **count of issues** or **point estimates** for each task, giving you the flexibility to use the metrics that work best for your team. +The burn-down and build-up charts are straightforward ways to gauge your cycle’s momentum. You can customize them to show progress based on the **count of work items** or **point estimates** for each task, giving you the flexibility to use the metrics that work best for your team. ![Scope](https://media.docs.plane.so/cycles/scope-change.webp#hero) - **Scope**\ - This is the total number of issues planned for the current cycle. + This is the total number of work items planned for the current cycle. - **Unstarted**\ - The issues that haven't begun yet + The work items that haven't begun yet - **Backlog**\ - All issues in an unstarted state + All work items in an unstarted state The other metrics are detailed below, tailored to each chart type. @@ -149,7 +185,7 @@ The burn-down chart gives you a clear visual of how much work remains in your cy The build-up chart helps track how much work has already been completed in the cycle. - **Today's ideal done**\ - This shows how many issues should be completed by today based on the ideal pace. + This shows how many work items should be completed by today based on the ideal pace. - **Done**\ This is the total number of tasks your team has completed so far. diff --git a/docs/core-concepts/deploy.mdx b/docs/core-concepts/deploy.mdx index ae1128c..fa57bf1 100644 --- a/docs/core-concepts/deploy.mdx +++ b/docs/core-concepts/deploy.mdx @@ -29,7 +29,7 @@ You can publish your project in either **Kanban** or **List** layouts. Choose wh - Project name - Project work items - - Issue ID + - Work item ID - Title - Description - State, due-date, priority @@ -40,7 +40,7 @@ You can publish your project in either **Kanban** or **List** layouts. Choose wh **Non-visible attributes** - Attachments -- Issue links +- Work item links - Relations - Cycles - Modules @@ -55,7 +55,7 @@ When turned on, users can sign up on the public board and add comments to work i When turned on, users can upvote or downvote any work item on the deployed board. This helps project managers or owners prioritize which work items need attention. -### Issue reactions +### Work item reactions When this feature is on, users can react to work items on the public board using predefined emoticons. This provides a quick way for team members and the public to express their sentiments about specific work items, aiding in gauging overall opinion and urgency. diff --git a/docs/core-concepts/export.mdx b/docs/core-concepts/export.mdx index e392cb5..6c57b47 100644 --- a/docs/core-concepts/export.mdx +++ b/docs/core-concepts/export.mdx @@ -3,6 +3,8 @@ title: Export description: Export work items from Plane in CSV, Excel, or JSON formats for backup, analysis, or sharing. --- +import Tags from "@site/src/components/Tags"; + # Export data Plane allows you to export all your work items—from a single project or multiple projects—so you can access your data outside of Plane. You can export work items into CSV, Excel, or JSON formats. Additionally, you can choose how you'd like the data to be packaged: in a single consolidated file or split into separate files (downloaded as a ZIP). @@ -11,7 +13,7 @@ Plane allows you to export all your work items—from a single project or multip All key fields related to your work items are included in the export, except for work item types, custom properties, relations, links, attachments, and estimates. We're actively working on adding these soon. ::: -## Export data +## Export projects > **Role**: Workspace Admins @@ -48,3 +50,32 @@ Exporting large workspaces may take some time depending on the number of work it :::caution Exported files remain downloadable for a limited time (7 days). ::: + +
+ ## Custom exports + +
+ +Export filtered work items, cycles, views, or modules directly from your project. Custom exports let you export exactly what you see after applying filters and display options—perfect for reports, analysis, or sharing specific data sets. + +You can export data from: + +- Work items: Export filtered work item lists from any view +- Cycles: Export work items within a specific cycle +- Modules: Export work items within a specific module +- Views: Export custom filtered views you've saved + +### How to export + +![Export work items](https://media.docs.plane.so/issues/export-work-items.webp#hero) + +1. Navigate to the work items, cycle, module, or view you want to export. +2. Apply any filters or display options to narrow down your data. +3. Click the ⋯ (more options) menu in the top right. +4. Select **Export**. +5. Choose your format: + - CSV: For spreadsheet applications. + - JSON: For programmatic use or data processing. +6. Click **Continue** to download your file. + +The exported file will include all visible work items based on your current filters and settings. \ No newline at end of file diff --git a/docs/core-concepts/pages/editor-blocks.mdx b/docs/core-concepts/pages/editor-blocks.mdx index 64a3004..beb0935 100644 --- a/docs/core-concepts/pages/editor-blocks.mdx +++ b/docs/core-concepts/pages/editor-blocks.mdx @@ -111,6 +111,30 @@ Or use single dollar syntax: Both equation types support full LaTeX rendering with built-in validation and error handling for invalid mathematical expressions. + +
+## Draw.io diagrams + +
+ +Create and manage interactive diagrams and whiteboards directly within your Pages using the integrated Draw.io editor. Whether you need professional flowcharts, system architecture diagrams, or freehand sketches for brainstorming, the diagram feature provides powerful visual documentation capabilities without leaving Plane. + +![Draw.io diagram](https://media.docs.plane.so/pages/draw-io-diagram.webp#hero) + +### Diagram +Create professional diagrams, flowcharts, and visual documentation using the full Draw.io editor with comprehensive shape libraries. Perfect for technical documentation, process flows, system architecture, network diagrams, and organizational charts. +Use the `/diagram` or `/drawio-diagram` slash command to insert a diagram block. Click the placeholder to launch the Draw.io editor. + +### Board +Create whiteboards with freehand drawing and sketching capabilities using a simplified interface. Ideal for brainstorming sessions, quick mockups, concept visualization, and collaborative ideation. +Use the `/board` or `/drawio-board` slash command to insert a whiteboard block. Click the placeholder that says "Click to start editing whiteboard" to launch the board interface. + +Both modes feature a consistent toolbar with **Save** and **Exit** buttons, making it easy to preserve your work and return to your Page. All diagrams are fully interactive—simply click any saved diagram to edit it again. + ## Callout Creates visually distinct sections with customizable icons and colors for highlighting warnings, tips , and calls-to-action. diff --git a/docs/core-concepts/pages/inline-comments.mdx b/docs/core-concepts/pages/inline-comments.mdx index b6d182f..4c8fbbf 100644 --- a/docs/core-concepts/pages/inline-comments.mdx +++ b/docs/core-concepts/pages/inline-comments.mdx @@ -84,7 +84,7 @@ Replies are threaded under the original comment, keeping related discussions org ### Resolve comments -When a discussion is complete or an issue has been addressed: +When a discussion is complete or a work item has been addressed: 1. Locate the checkmark icon next to the comment (in the top-right area). 2. Click the checkmark icon. @@ -94,7 +94,7 @@ The comment will be hidden from the default view and moved to the resolved comme ### Unresolve comments -If a discussion needs to be reopened or the issue resurfaces: +If a discussion needs to be reopened or the work item resurfaces: 1. Use the Filters button to show resolved comments. 2. Locate the resolved comment you want to reopen. diff --git a/docs/core-concepts/pages/overview.mdx b/docs/core-concepts/pages/overview.mdx index aeca439..c1d6409 100644 --- a/docs/core-concepts/pages/overview.mdx +++ b/docs/core-concepts/pages/overview.mdx @@ -104,7 +104,7 @@ Duplicate an existing page to jumpstart new content. ### Move Page -Transfer a Page to a different project in your workspace. +Transfer a page to Wiki, Teamspace or a different Project in your workspace. ### Lock Page diff --git a/docs/core-concepts/projects/milestones.mdx b/docs/core-concepts/projects/milestones.mdx new file mode 100644 index 0000000..b8aad41 --- /dev/null +++ b/docs/core-concepts/projects/milestones.mdx @@ -0,0 +1,71 @@ +--- +title: Milestones +hide_title: true +description: Align work items toward shared completion dates with milestones. Track progress on quarterly objectives, product launches, and strategic initiatives in Plane. +--- + +import Tags from "@site/src/components/Tags"; + +
+ # Track goals with Milestones + +
+ +Milestones provide a layer to align work items and epics toward shared completion dates, helping teams focus on strategic objectives and critical deliverables. Whether tracking quarterly goals, product launches, or major feature releases, milestones give you visibility into progress and ensure teams stay on track. + +## Set up milestones +Workspace and project admins can turn on the Milestones feature in the project. + +![Enable Milestones](https://media.docs.plane.so/milestones/set-up-milestones.webp#hero) + +To enable milestones in your project: + +1. Go to **Project Settings → Features**. +2. Toggle on **Milestones** under the **Work management** section. +3. A **Milestones** section will appear in your project's Overview page. + +## Create a milestone +![Create Milestones](https://media.docs.plane.so/milestones/create-milestone.webp#hero) + +From your project's Overview page: + +1. Scroll down to the **Milestones** section. +2. Click **Create** or the **+** icon to add a new milestone. +3. Enter the milestone details: + - Title: Name your milestone (e.g., "Q4 Launch", "MVP Release"). + - Description: Add context about the milestone's purpose and goals. + - Target date: Set the completion deadline. + - Link work items: Associate relevant work and epics with the milestone. +4. Click **Create** to save your milestone. + +## Manage milestones + +### Track progress +![Manage Milestones](https://media.docs.plane.so/milestones/manage-milestone.webp#hero) + +Each milestone displays: + +- Completion percentage: Based on linked work items and epics. +- Target date: Deadline with visual indicators for approaching or overdue milestones + +Click on a milestone to expand and see all linked work items. The progress bar updates automatically as work items are completed or cancelled. + +### Link work items and epics +You can link work items and epics to milestones in two ways: + +**From the milestone** +Click **Link work items** and select work items and epics from your project. + +**From the work item or epic** +Open any work item or epic and assign it to a milestone from the properties panel. + +![Link work items](https://media.docs.plane.so/milestones/link-work-items.webp#hero) + +### Edit or delete milestones +Update milestone details anytime: + +- Modify the title, description, or target date. +- Adjust linked work items. +- Track metrics and progress indicators. +- Click the ⋯ menu for additional options. + diff --git a/docs/importers/asana.mdx b/docs/importers/asana.mdx index 138f036..64ea328 100644 --- a/docs/importers/asana.mdx +++ b/docs/importers/asana.mdx @@ -85,7 +85,7 @@ Here’s a quick look at what gets imported during the migration from Asana to P | Reporter | Created by | | | Created | Created at | | | Assignee | Assignees | If you skip user import during migration, this will be blank. | -| Issue types | Labels \| Prefix in Issue title | | +| Issue types | Labels \| Prefix in Work item title | | | Images in the Issue description | Images in the Work item description | | | Summary | Work item title | | | Start date | Start date | | diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx index 213a774..4dfec55 100644 --- a/docs/integrations/slack.mdx +++ b/docs/integrations/slack.mdx @@ -92,8 +92,8 @@ If a message sparks an action item, turn it into a Plane work item in just a few 3. A modal will open where you can select the project. 4. Add a title and description (the original message is pre-filled). 5. Assign Labels, State, Priority, and Assignee. -6. Enable Thread Sync (optional). When enabled, Thread Sync keeps your conversation and Plane issue comments in sync. Anything you say in the Slack thread appears in the Plane work item comments, and vice versa. It’s the easiest way to keep everyone aligned without repeating updates in two places. -7. Once you hit **Create Issue**, the issue gets added to the Backlog of your selected project, and a preview is posted in the Slack thread so everyone knows it's being tracked. +6. Enable Thread Sync (optional). When enabled, Thread Sync keeps your conversation and Plane work item comments in sync. Anything you say in the Slack thread appears in the Plane work item comments, and vice versa. It’s the easiest way to keep everyone aligned without repeating updates in two places. +7. Once you hit **Create Issue**, the work item gets added to the Backlog of your selected project, and a preview is posted in the Slack thread so everyone knows it's being tracked. #### `/plane` command @@ -116,11 +116,11 @@ If a Plane work item already exists, and you want to connect it to a Slack threa ![Link Work Item](https://media.docs.plane.so/integrations/slack/link-work-item.webp#hero) 3. In the modal, search for the work item by title or ID. -4. Select the right issue and hit **Link**. +4. Select the right work item and hit **Link**. -That’s it. Now the thread and the work item are connected. Comments in the thread can sync to Plane (and vice versa, if **Thread Sync** is enabled on that issue), and the thread will display a rich preview of the linked work item. +That’s it. Now the thread and the work item are connected. Comments in the thread can sync to Plane (and vice versa, if **Thread Sync** is enabled on that work item), and the thread will display a rich preview of the linked work item. -This is perfect for situations where someone logs an issue in Plane but the conversation about it happens in Slack. Just link them up and avoid duplication. +This is perfect for situations where someone logs a work item in Plane but the conversation about it happens in Slack. Just link them up and avoid duplication. ### Add Plane to private Slack channels When you use Plane in public Slack channels, it automatically adds the Plane bot to those channels. However, for private channels, you must manually add the bot before you can create or link work items. @@ -161,7 +161,7 @@ Once set, Plane will automatically post updates to the selected Slack channel ev ### Link previews -When you share a Plane Issue, Cycle, or Module link in Slack, you’ll see a live preview of its details, including: +When you share a Plane Work item, Cycle, or Module link in Slack, you’ll see a live preview of its details, including: - **Issues** Title, status, priority, assignee, and quick actions. diff --git a/docs/introduction/tutorials/invite-members.mdx b/docs/introduction/tutorials/invite-members.mdx index ee19727..11dd8a7 100644 --- a/docs/introduction/tutorials/invite-members.mdx +++ b/docs/introduction/tutorials/invite-members.mdx @@ -57,7 +57,7 @@ For each person you're inviting, select their role from the dropdown. #### 👥 Member (Default) -- Can create projects, issues, and collaborate fully +- Can create projects, work items, and collaborate fully - Cannot change workspace settings or manage other members - Best for most team members, developers, designers, project contributors diff --git a/sidebars.ts b/sidebars.ts index 04e7151..513c774 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -153,6 +153,7 @@ const sidebars: SidebarsConfig = { "core-concepts/issues/timeline-dependency", "core-concepts/projects/initiatives", "core-concepts/workspaces/teamspaces", + "core-concepts/projects/milestones", "core-concepts/stickies", ], },