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
24 changes: 4 additions & 20 deletions docs/core-concepts/account/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,33 +1,17 @@
---
title: Overview
title: Home and Your work
---

Your account encompasses details of your profiles, workspaces, activities, and preferences. Within a workspace, your account information is utilized to customize the Home page and to display your notifications.
Home and Your work is your central hub for staying organized and tracking progress within your workspace. It provides a comprehensive view of your work, recent activities, and team collaborations—all in one place.

## Workspace home
## Home

Once logged in and within a workspace, the home page reflects your involvement in issues - those assigned to you, created by you, and completed by you. You can readily identify both due and overdue issues. Additionally, you have the option to view issues assigned to you categorized by their state and priority. Your recent activities, projects, and collaborators are also easily accessible on the home page.

![Home](https://media.docs.plane.so/account/account-dashboard.webp#center)

## Workspace notifications

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

- Changes in issue state or properties made by others
- Mentions of you on issues
- Comments added to issues
- Issues created and assigned to you

Moreover, if you've activated Email notifications, you'll receive these notifications via email as well.

![Notifications](https://media.docs.plane.so/account/account-notifications.webp#center)

## Workspace profile

Access your workspace profile from the side-navigation bar by clicking on your name's initial/profile picture and selecting "View profile"

![Profile dropdown](https://media.docs.plane.so/account/account-profile-dropdown.webp#center)
## Your work

Your workspace profile consolidates information regarding your individual work and progress. It includes your workload, activity log, and a breakdown of issues by status and priority. Additionally, you'll find a list of all the issues assigned to you, created by you, and explicitly subscribed.

Expand Down
9 changes: 8 additions & 1 deletion docs/core-concepts/account/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Settings
title: Profile
---

Your account settings offer the ability to adjust your profile details, password, theme preferences, and email notification settings. Additionally, you can access a comprehensive list of all activities across workspaces.
Expand Down Expand Up @@ -35,4 +35,11 @@ To create your custom theme, you can specify the following:

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.

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:

- Changes in issue state or properties made by others
- Mentions of you on issues
- Comments added to issues
- Issues created and assigned to you

![Email](https://media.docs.plane.so/account/account-email-preferences.webp#center)
2 changes: 1 addition & 1 deletion docs/core-concepts/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Publish
---

# Publish your Projects
# Publish your projects

Any project you build in Plane can be turned into a public page, creating a fully navigable website. This makes it easy for your users and customers to see your latest features or when bug fixes roll out—no sign-up required.

Expand Down
8 changes: 0 additions & 8 deletions docs/core-concepts/drafts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,3 @@ Created a draft you no longer need? Deleting it is easy. Click **Delete**, confi
:::caution
Keep in mind, deleted drafts cannot be recovered. You'll always see a confirmation modal to prevent accidental deletions.
:::

## Troubleshooting
Here are a few common troubles you may have and their possible solutions.

- **Draft does not appear after auto-save**
Refresh your page and make sure you are online. If this persists, try clearing your browser’s cache.
- **Unable to move a draft issue to an active project cycle**
Double-check that all the required fields are filled out and that the draft is properly assigned to the running cycle in a project before moving it.
45 changes: 45 additions & 0 deletions docs/core-concepts/issues/estimates.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Estimates
---

# Estimate effort for issues

Estimates in Plane help quantify the effort required for each issue in your project. Whether using a simple number scale or categories like T-shirt sizes, estimates provide a clearer idea of the work involved. They act as a proxy for complexity, helping teams gauge task scale quickly without detailed breakdowns. Estimates also aid in prioritizing, resource allocation, managing workload expectations, and identifying potential bottlenecks.

## Set up estimates

By default, your project won’t have an estimate system. To get started, go to the **Estimates** tab under **Project > Settings**.
Once there, click **Add estimate system** and you can choose from the following estimate systems:

### Points

This system uses numeric values to quantify effort, making it a great fit for teams that prefer to track progress based on numbers. Plane offers several preset progressions for you to choose from:

- **Linear**
A simple, evenly spaced number progression.
- **Fibonacci**
A more dynamic progression where each number is the sum of the previous two (e.g., 1, 2, 3, 5, 8, 13, etc.). This is useful when estimating tasks of varying complexity.
- **Squares**
A progression where each value is the square of the number (e.g., 1, 4, 9, 16, etc.).
- **Custom**
Create your own progression to match your team's specific needs.

### Category

If you prefer to estimate effort by text categories rather than numbers, this is the system for you. Typical examples include:

- **T-shirt sizes**
A common approach to estimating effort, this system uses sizes like XS, S, M, L, and XL to represent the complexity or effort of an issue. This method is popular in agile teams for its simplicity.
- **Easy to Hard**
This system uses categories like "Easy", "Medium", and "Hard" to represent how difficult or time-consuming an issue might be. It's useful when you want to quickly categorize tasks without needing exact numbers.
- **Custom**
You can create your own custom categories to fit your team’s workflow. Whether you want to use something like "Low", "Medium", "High" or something more specific to your project, the custom option allows complete flexibility.

This system provides a high-level estimate of effort based on intuitive categories, which is especially helpful in teams where relative effort matters more than precise numeric estimates.


When you are done, you can enable estimates by clicking on **Create estimates**. You can also change the type of the system by clicking the pencil icon next to the system you have set.

:::note
In earlier versions of Plane, we allowed multiple estimate systems within a single project, giving you the ability to switch between them. Based on user feedback, we’ve simplified this process. Now, each project can only have one active estimate system, and older, inactive systems have been archived for better clarity and ease of use.
:::
42 changes: 42 additions & 0 deletions docs/core-concepts/issues/labels.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Labels
---

# Organize issues with Labels

Labels are keywords or tags that you can assign to issues in order to categorize and differentiate them within your project. They are ideal for tracking components or other unique identifiers that don’t fall under the standard issue properties.

Labels can be used to group issues by common attributes, such as type, feature, or any other custom classification. They make it easier to filter and find related issues across your project.

## Manage labels

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

You can manage your labels in the **Labels** tab in your project settings. From here, you can create, edit, and delete labels.

### Create labels

To create a new label:

1. Click the **Add label** button.
2. Name your label, choose a color (optional)
3. Click **Add** to save your label.

:::tip
You can also create labels directly from the issue detail page, making it super easy to tag issues as you go.
:::

### Edit labels

1. Click the … icon on the label you want to edit and select **Edit label**.
2. Update the label name or color as needed.
3. Click **Update** to save your changes.

### Delete labels

1. Ensure no active issues are using the label.
2. Click the **x** icon on the label to delete it.

:::caution
Removing a label from your project will dissociate it from any issues that had it assigned.
:::
37 changes: 37 additions & 0 deletions docs/core-concepts/issues/layouts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Layouts
---

# See, plan and track issues with Layouts

Plane offers five different ways to view and manage your issues, each designed to help your team work more effectively.

## List layout

The List layout shows all issues in a simple, ordered list. You can group issues by priority, assignee, or labels to see your work from different angles. It's straightforward and gives you a clear overview of everything happening in your project.

![issue-list](https://media.docs.plane.so/issues/issue-list-layout.webp#center)

## Board layout

Think of the Board layout like a digital whiteboard. Issues are organized into columns (like Backlog, Todo, In Progress, Done), making it easy to see where things stand. Just drag and drop issues between columns to update their status quickly.

![issue-kanban](https://media.docs.plane.so/issues/issue-kanban-layout.webp#center)

## Calendar layout
The Calendar layout maps out your issues by their due dates. It's perfect for tracking deadlines and planning ahead. Whether you're mapping out a sprint or checking what's coming up, this view keeps your schedule in focus.

![issue-calendar](https://media.docs.plane.so/issues/issue-calendar-layout.webp#center)

## Table layout
The Table layout is like a spreadsheet for your issues. Each row is an issue, with columns showing all the details. It's great when you need to make bulk changes or want to see every piece of information at once.

![issue-spreadsheet-layout](https://media.docs.plane.so/issues/issue-spreadsheet-layout.webp#center)

## Timeline layout
The Timeline layout (or Gantt chart) shows your project's progress over time. You can see how long tasks take, when they start and finish, and how they connect to each other. It's ideal for understanding the big picture of your project's workflow.

![issue-gantt](https://media.docs.plane.so/issues/issue-gantt-layout.webp#center)

----
Each layout offers a different lens to view your work. Switch between them to find the perspective that helps your team work best.
Loading