Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/core-concepts/account/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To create your custom theme, you can specify the following:

## Notifications

By default, email-based notifications are disabled for new users. You have the option to enable all notifications or select specific types of notifications. Once you save your preferences, you will only receive email notifications for issues that match the preferences you have selected.
By default, email-based notifications are disabled for new users. You have the option to turn on all notifications or select specific types of notifications. Once you save your preferences, you will only receive email notifications for issues that match the preferences you have selected.

Notifications include updates on issues you've created, are assigned to, or have subscribed to. These notifications can also be found in the Inbox section on your sidebar. They encompass:

Expand Down
37 changes: 35 additions & 2 deletions docs/core-concepts/cycles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ A Cycle is a set period of time where your team focuses on completing specific t

Using Cycles, your team stays organized, meets deadlines, and keeps moving forward efficiently. It’s all about getting things done without the overwhelm!

## Enable cycles
By default, Cycles are automatically enabled when you create a new project. If you ever want to switch them off or back on, you can easily do that by navigating to **Settings > Features** in your project's ellipsis (…) menu.
## Turn on cycles
By default, Cycles are automatically turned on when you create a new project. If you ever want to switch them off or back on, you can easily do that by navigating to **Settings > Features** in your project's ellipsis (…) menu.

## Create cycles
:::warning[Caution]
Expand Down Expand Up @@ -46,6 +46,39 @@ When a cycle’s due date has passed, it moves into the completed state. This re
You can modify the name, description, start and due dates of active and upcoming cycles at any time.
:::

<div className="tag-wrapper">
## Start and stop cycles
<Tags
tags={[
{ name: "Pro", additionalClass: "pro" }
]}
/>
</div>

While Cycles typically run for their set duration, sometimes you need more flexibility in managing your work periods. You can manually control when a Cycle begins or ends using the interface controls.

To start a Cycle, simply click the **Start Cycle** button next to your upcoming Cycle. This is particularly useful when you want to begin a planned Cycle earlier than its scheduled start date or if you need to start a fresh Cycle immediately.

![Start Cycle](https://media.docs.plane.so/cycles/start-cycle.webp#center)

To end a Cycle before its scheduled completion date, you can:

1. Click the three-dot menu (⋯) on the active Cycle.

2. Select **End Cycle** from the three dots menu to the right of the active cycle.

:::warning
You can't restart a Cycle after it's been manually ended.
:::

3. Once you end a Cycle, it will be marked as completed and move to your **Completed cycle** section.

![End Cycle](https://media.docs.plane.so/cycles/end-cycle.webp#center)

Any unfinished issues in the ended Cycle will remain in their current state. The burn-down chart and progress metrics will be finalized based on the completion status at the time you end the Cycle.

This manual control gives you the flexibility to adapt your Cycles to your team's actual work rhythm, rather than being strictly bound to predetermined dates.

## Transfer issues

Once the due date of an active Cycle passes, it’s automatically marked as completed. After that, you can easily transfer any unfinished issues to an active or upcoming cycle, making it simple to move any leftover tasks to the next cycle.
Expand Down
6 changes: 3 additions & 3 deletions docs/core-concepts/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Only Admins can publish a project in Plane. Here’s how:

### Layout options

You can publish your project in either **Kanban** or **List** layouts. Choose whichever view best fits your project, or enable both to give viewers more flexibility. Soon, Gantt and Spreadsheet layouts will also be available.
You can publish your project in either **Kanban** or **List** layouts. Choose whichever view best fits your project, or turn on both to give viewers more flexibility. Soon, Gantt and Spreadsheet layouts will also be available.

#### Attribute privacy

Expand Down Expand Up @@ -48,11 +48,11 @@ You can publish your project in either **Kanban** or **List** layouts. Choose wh

### Commenting options

When enabled, users can sign up on the public board and add comments to issues—ideal for gathering feedback and showing progress.
When turned on, users can sign up on the public board and add comments to issues—ideal for gathering feedback and showing progress.

### Upvotes and downvotes

When enabled, users can upvote or downvote any issue on the deployed board. This helps project managers or owners prioritize which issues need attention.
When turned on, users can upvote or downvote any issue on the deployed board. This helps project managers or owners prioritize which issues need attention.

### Issue reactions

Expand Down
6 changes: 3 additions & 3 deletions docs/core-concepts/intake.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ sidebarTitle: Intake

Intake is a Plane-only feature that lets `Guests` create issues following which `Admins` and `Members` can move these issues inside a project. Intake can take bug reports, feature or service requests, or raise a ticket by stakeholders, customers, or clients. Issues created in Intake can then be accepted to move them to the Project’s workflow.

## Enable Intake
## Turn on Intake

Intake functions at the project level and is toggled off by default. Project `Admins` can enable the Intake feature for the project.
Intake functions at the project level and is toggled off by default. Project `Admins` can turn on the Intake feature for the project.

1. Click the three-dots icon next to your project name on the left pane and click **Settings**.
2. Select **Features** on the right pane.
3. Switch on the toggle button for the **Intake** feature to enable it on the project.
3. Switch on the toggle button for the **Intake** feature to turn it on for the project.

![enable-intake-feature](https://media.docs.plane.so/intake/enable-intake-feature.webp#center)

Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/issues/bulk-ops.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Bulk Ops
title: Bulk operations
hide_title: true
---

Expand Down
13 changes: 5 additions & 8 deletions docs/core-concepts/issues/epics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ Use Epics when you need to:
Use an Epic for larger bodies of work that span multiple cycles and extend across different modules.
:::

## Enable Epics
## Turn on Epics

![Enable Epics](https://media.docs.plane.so/epics/enable-epics.webp#center)

To start using Epics, enable the feature for your project:
To start using Epics, turn on the feature for your project:

1. Go to the [Project settings](/core-concepts/projects/overview#project-settings) for the desired project.
2. Navigate to the **Epics** section on the right pane.
3. Click the **Enable** button.

Once enabled, the Epics tab will appear in the project's sidebar, giving you quick access to create and manage Epics.
Once turned on, the Epics tab will appear in the project's sidebar, giving you quick access to create and manage Epics.

## Add custom properties to Epics

Expand Down Expand Up @@ -104,7 +104,7 @@ An issue can belong to only one Epic. This ensures clarity in organization and a
![Epic progress](https://media.docs.plane.so/epics/epic-progress.webp#center)

You can track Epic progress visually with a color-coded progress bar that shows:
- Task completion status (e.g., Overdue, Backlog, Started, Completed).
- Task completion status (e.g., Backlog, Started, Completed).
- Issue counts and completion percentage for each status category.

### Properties, comments, and activity
Expand All @@ -123,10 +123,7 @@ For each issue, you can assign or change an issue's Epic directly in the **Paren

![Link Issues to Epics](https://media.docs.plane.so/epics/link-issue-epic.webp#center)

## Example use cases
- **Product development**: Use Epics to group tasks for new feature rollouts.
- **Marketing campaigns**: Organize deliverables like content creation, design, and ads under a single Epic.
- **Bug fixing**: Track related issues for a major bug-fixing sprint.
---

Epics provide a simple yet powerful way to manage larger goals while keeping your projects organized and your team aligned.

2 changes: 1 addition & 1 deletion docs/core-concepts/issues/issue-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Issue Types make these and infinite other use cases possible.
## Create issue types

:::warning
The Issue Types feature cannot be disabled once enabled for a Plane project.
The Issue Types feature cannot be disabled once turned on for a Plane project.
:::

> **Role**: Project Admins
Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/issues/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can also head over to the **Issues** tab in the sidebar and click **Add Issu

![Create issue](https://media.docs.plane.so/issues/create-issue-modal.webp#center)

In the **Create new issue** modal, you can define all the attributes of the issue, including title, description, assignees, state, priority, labels, due dates, and more. You can also enable the **Create more** option to add multiple issues one after the other.
In the **Create new issue** modal, you can define all the attributes of the issue, including title, description, assignees, state, priority, labels, due dates, and more. You can also turn on the **Create more** option to add multiple issues one after the other.

When you create an issue, Plane assigns it a sequential identifier based on your project (e.g., PROJ-1).

Expand Down
4 changes: 2 additions & 2 deletions docs/core-concepts/issues/properties.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ A breakdown of all the properties available in issues for members to update.
| Labels | Categorize your issue with labels created within the project. |
| Start date | Date when the assignee will start working on the issue. |
| Due date | Date when the assignee is supposed to close the issue. |
| Cycle | If cycles are enabled in your project, you can select the cycle you want the issue to be added in. |
| Modules | If modules are enabled in your project, you can select the modules you want to link to the issue. |
| Cycle | If cycles are turned on in your project, you can select the cycle you want the issue to be added in. |
| Modules | If modules are turned on in your project, you can select the modules you want to link to the issue. |
| Links | External links for the issue. |
| Parent | Mark a parent issue for the issue you are creating. |
| Blocking | Can be linked to issues which are being blocked by the current issue. |
Expand Down
8 changes: 4 additions & 4 deletions docs/core-concepts/issues/time-tracking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ Project members can easily log the time they spend working on specific issues di
</iframe>
</div>

## Enable Time Tracking
To enable the Time Tracking feature on your project, follow the steps below:
## Turn on Time Tracking
To turn on the Time Tracking feature on your project, follow the steps below:

1. Click the **…** icon next to your project name on the sidebar and click **Settings**.
![Project settings](https://media.docs.plane.so/time-tracking/project-settings.webp#center)

2. Select **Features** on the right pane. Enable the **Time Tracking** toggle button.
2. Select **Features** on the right pane. Turn on the **Time Tracking** toggle button.
![Enable time tracking](https://media.docs.plane.so/time-tracking/enable-time-tracking.webp#center)

The Time Tracking feature is now enabled for your project.
The Time Tracking feature is now turned on for your project.

## Log time

Expand Down
4 changes: 2 additions & 2 deletions docs/core-concepts/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ title: Modules

Modules are smaller, focused projects that help users group and organize issues within specific time frames. They allow teams to break down their work into manageable chunks and track progress towards specific goals or objectives. They can serve various purposes: tracking progress on a new feature, managing a milestone like a marketing campaign, or representing discrete pieces of your software architecture such as a microservice.

## Enable Modules
## Turn on Modules

By default, Modules are enabled for all new projects. If you need to enable or disable them later, head to [Project settings](/core-concepts/projects/overview#project-settings) and toggle the Modules feature as needed.
By default, Modules are turned on for all new projects. If you need to turn them on or off later, head to [Project settings](/core-concepts/projects/overview#project-settings) and toggle the Modules feature as needed.

## Create Module

Expand Down
4 changes: 2 additions & 2 deletions docs/core-concepts/pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import Tags from '@site/src/components/Tags';

Pages in Plane let you easily capture and organize project-related information. Whether you’re documenting meeting notes or detailing technical or product requirements, Pages allow you to collaborate directly within the context of your project—no need for external tools.

## Enable Pages
Pages are enabled by default when you create a new project. If needed, you can disable or re-enable them later in your project settings.
## Turn on Pages
Pages are turned on by default when you create a new project. If needed, you can turn it on or off later in your project settings.

## Create Page
- To create a new page, simply press `D` within your project, or head to the **Pages** section in the sidebar and click the **Add page** button at the top right of your screen.
Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/projects/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ If you want to make sure every issue gets assigned, you can set a **Default assi

## Enable features

After creating a project, you can enable specific features based on your requirements:
After creating a project, you can turn on specific features based on your requirements:

- **Cycles**: Timebox issues in your project, helping to build momentum and keep things moving forward.
- **Modules**: Group related issues together logically, making it easier to manage large projects.
Expand Down
4 changes: 2 additions & 2 deletions docs/core-concepts/projects/project-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Project overview
title: Project Overview
hide_title: true
---

Expand Down Expand Up @@ -59,7 +59,7 @@ Quickly view and edit project properties in the info icon tab on the side panel.
## Project updates
Share project status using updates. This helps keep your team informed and create a timeline of project progress.

### Enable project updates
### Turn on project updates

Go to your [project's settings](/core-concepts/projects/overview#project-settings) and turn on **Project Updates**.

Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/projects/project-states.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Project states
title: Project States
hide_title: true
---

Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/projects/run-project.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Start by choosing an estimate system from the two below.

Use this if you would like to estimate effort by alphabetical text. Typical examples include T-shirt sizing or easy-to-hard estimate systems.

When you are done, you can enable estimates by toggling on `Enable estimates for my project`. You can also change the type of the system by clicking the pencil icon next to each system you have set.
When you are done, you can turn on estimates by toggling on `Enable estimates for my project`. You can also change the type of the system by clicking the pencil icon next to each system you have set.

:::warning
In previous versions of Estimates we let you add more than one estimate system so you could switch between them. After overwhelming feedback to make it simpler for you, we now let you create one system per project. Inactive estimate systems from previous versions are now archived.
Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/views.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These are created at the Workspace level and are available to all Members, depen
![Workspace Views](https://media.docs.plane.so/views/workspace-views.webp#center)

- **Project Views**
These Views are created within the specific project and are accessible to all Members of the project, depending on whether they are set as public or private. This feature is enabled by default and can be toggled on or off from the [project settings](/core-concepts/projects/overview#project-settings).
These Views are created within the specific project and are accessible to all Members of the project, depending on whether they are set as public or private. This feature is turned on by default and can be toggled on or off from the [project settings](/core-concepts/projects/overview#project-settings).

![Project Views](https://media.docs.plane.so/views/project-views.webp#center)

Expand Down
2 changes: 1 addition & 1 deletion docs/core-concepts/workspaces/members.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Members are your core team. They can create, edit, and delete content in project
Guests are external collaborators—like clients or contractors—who need limited access. They can only view the specific content they’ve been invited to. This role is perfect for keeping outsiders in the loop without giving them full access.

### Grant view access to Guests
You can enable this setting in **Project Settings > Members**. Enabling this setting allows guest users to view all project issues, providing them with broader visibility into the project's progress and details. This is useful for external stakeholders who need full context without editing permissions.
You can turn on this setting in **Project Settings > Members**. Enabling this setting allows guest users to view all project issues, providing them with broader visibility into the project's progress and details. This is useful for external stakeholders who need full context without editing permissions.
![Grant guest users view access](https://media.docs.plane.so/workspaces/grant-guests-view-access.webp#center)

## Permissions
Expand Down
Loading