Skip to content

Commit c75d3c7

Browse files
Merge pull request #189 from makeplane/preview
Added pages for Project States and Exports
2 parents fedcfc4 + 8efd9d4 commit c75d3c7

File tree

4 files changed

+126
-6
lines changed

4 files changed

+126
-6
lines changed

docs/core-concepts/export.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Exports
3+
---
4+
5+
# Export issues to backup, analyze, or share your data
6+
7+
Plane allows you to export all your issues—from a single project or multiple projects—so you can access your data outside of Plane. You can export issues 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).
8+
9+
:::caution[Limitation]
10+
All key fields related to your issues are included in the export, except for issue types, custom properties, relations, links, attachments, and estimates. We're actively working on adding these soon.
11+
:::
12+
13+
## Export data
14+
> **Role**: Workspace Admins
15+
16+
1. Go to your **Workspace Settings**.
17+
2. In the right pane, select **Exports**.
18+
3. **Choose format**
19+
You can export issues in one of the following formats:
20+
- CSV: A plain text file with values separated by commas.
21+
- Excel: A formatted spreadsheet file.
22+
- JSON: A lightweight, machine-readable format.
23+
24+
Click the **Export** button for your preferred format.
25+
26+
4. **Select Projects**
27+
After selecting your format:
28+
- Choose to export issues from all projects or a specific project using the dropdown.
29+
- *Optional*: If exporting issues from all projects, you can split the data into separate files. This will package the exports into a ZIP file.
30+
31+
:::info
32+
Exporting large workspaces may take some time depending on the number of issues.
33+
:::
34+
35+
5. **Download file**
36+
You can view the history of your exports under **Previous exports**. For each export:
37+
38+
- You'll see its status (e.g., Queued, Completed).
39+
- The date and the name of the user who triggered the export.
40+
- Once completed, you can download the file by clicking **Download**.
41+
- Click the **Refresh status** button to ensure the latest updates.
42+
43+
:::caution
44+
Exported files remain downloadable for a limited time (7 days).
45+
:::
46+
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: State Of Projects
3+
hide_title: true
4+
---
5+
6+
import Tags from '@site/src/components/Tags';
7+
8+
<div className="tag-wrapper">
9+
# Manage project progress with states
10+
<Tags
11+
tags={[
12+
{ name: "Pro", additionalClass: "pro" }
13+
]}
14+
/>
15+
</div>
16+
17+
Project States allows you to track the overall progress of your projects. With this tool, you can categorize projects into different states, helping you quickly identify which projects need attention and which are on track.
18+
19+
This feature provides a central view of all projects in your workspace, making it easier to manage priorities and understand progress.
20+
21+
## Enable Project States
22+
> **Role**: Workspace Admins
23+
24+
1. Navigate to **Workspace Settings > Project States**.
25+
![Enable Project States](https://media.docs.plane.so/projects/enable-project-states.webp#center)
26+
27+
2. Toggle the switch to turn on the feature.
28+
29+
3. There are default project state groups:
30+
- **Draft**
31+
- **Planning**
32+
- **Execution**
33+
- **Monitoring**
34+
- **Completed**
35+
- **Cancelled**
36+
37+
![Add or modify Project States](https://media.docs.plane.so/projects/add-modify-project-states.webp#center)
38+
39+
4. **Modify state**
40+
1. Click the pencil icon to edit the default state name and description.
41+
2. Click **Update** to save changes.
42+
43+
5. **Add new state**
44+
1. Use the **+** button to add a new state.
45+
2. Provide a name and description for the new state.
46+
3. Click **Create**.
47+
48+
You’ll be able to apply these states to all projects in your workspace and begin tracking their progress.
49+
50+
## Use Project States
51+
52+
1. Navigate to **Projects** on the sidebar.
53+
![Add or modify Project States](https://media.docs.plane.so/projects/modify-project-states.webp#center)
54+
55+
2. In each project card, you'll see a bunch of project properties.
56+
57+
- State: Set the project state.
58+
- Priority: Highlight high-priority projects.
59+
- Lead: Assign or change the project lead.
60+
- Members: Update the team members working on the project.
61+
- Start and End Dates: Add or adjust timelines.
62+
63+
## Why use Project States?
64+
65+
- **Stay organized**
66+
Group projects based on their current stage, making it easier to prioritize and plan.
67+
- **Quick overview**
68+
Gain a snapshot of all projects from a single view.
69+
- **Customizable workflow**
70+
Adapt states to fit your team’s unique processes.

docs/devices/mobile.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,6 @@ View a list of all, active and backlog issues.
170170
</div>
171171
</div>
172172
<br/>
173-
173+
174+
## Push notifications
175+
The Plane mobile app supports push notifications to keep you updated on important activities. To start receiving notifications, make sure to enable them in the app settings. Once enabled, you'll be notified about relevant updates, ensuring you never miss an important change or task.

sidebars.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ const sidebars: SidebarsConfig = {
6969
collapsed: false,
7070
label: 'Project + work management',
7171
items: [
72+
'core-concepts/projects/project-states',
7273
'core-concepts/issues/issue-types',
7374
'core-concepts/issues/time-tracking',
74-
'core-concepts/issues/timeline-dependency'
75+
'core-concepts/issues/timeline-dependency',
76+
'core-concepts/export',
7577
],
7678
},
7779
{
@@ -155,17 +157,17 @@ const sidebars: SidebarsConfig = {
155157
{
156158
type: 'category',
157159
collapsed: false,
158-
label: 'Devices',
160+
label: 'Performance',
159161
items: [
160-
'devices/mobile',
162+
'performance/hyper-mode'
161163
],
162164
},
163165
{
164166
type: 'category',
165167
collapsed: false,
166-
label: 'Performance',
168+
label: 'Devices',
167169
items: [
168-
'performance/hyper-mode'
170+
'devices/mobile',
169171
],
170172
},
171173
{

0 commit comments

Comments
 (0)