Skip to content

Commit 68c986d

Browse files
Merge pull request #202 from makeplane/preview
Project Overview
2 parents 66ff82e + 50853f3 commit 68c986d

File tree

3 files changed

+97
-4
lines changed

3 files changed

+97
-4
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Project overview
3+
hide_title: true
4+
---
5+
6+
import Tags from '@site/src/components/Tags';
7+
8+
<div className="tag-wrapper">
9+
# Monitor project progress at a glance
10+
<Tags
11+
tags={[
12+
{ name: "Pro", additionalClass: "pro" }
13+
]}
14+
/>
15+
</div>
16+
17+
Without a centralized dashboard, teams often face challenges like fragmented information, inefficient progress tracking, and communication gaps.
18+
19+
Project Overview offers a centralized space for teams to monitor project health, track progress, and collaborate effectively. It consolidates key project metrics, updates, and collaboration tools into a single view. Whether you're a project lead, team member, or stakeholder, this feature provides the visibility you need to stay informed and aligned.
20+
21+
## Access Project overview
22+
23+
Navigate to **Issues** under your project and click **Overview** on the top bar. Alternatively, click the project name at the top left when working within other sections like Cycles or Pages.
24+
25+
![Access Project Overview](https://media.docs.plane.so/projects/access-project-overview.webp#center)
26+
27+
## Project header
28+
29+
The header includes the project details and quick access to essential actions.
30+
31+
- Add a custom banner and project icon to personalize your dashboard.
32+
- Write key details about your project plan, goals, and success metrics, helping your team stay aligned and focused.
33+
- Attach links or resources directly to the dashboard.
34+
35+
![Project header](https://media.docs.plane.so/projects/project-header.webp#center)
36+
37+
## Project metrics
38+
You can view overall project completion percentages. Metrics are displayed visually with status bars to help identify bottlenecks.
39+
40+
![Project Progress](https://media.docs.plane.so/projects/project-progress.webp#center)
41+
42+
This helps to identify overdue tasks and track progress over time. Task status breakdown:
43+
- **Overdue**: Tasks past their due dates.
44+
- **Backlog**: Tasks that are planned but not yet prioritized.
45+
- **Unstarted**: Tasks yet to begin.
46+
- **Started**: Tasks currently in progress.
47+
- **Completed**: Tasks that are done.
48+
49+
## Project properties
50+
51+
![Project properties](https://media.docs.plane.so/projects/project-properties.webp#center)
52+
53+
Quickly view and edit project properties in the info icon tab on the side panel.
54+
55+
- **State**: Displays the current state of the project (e.g., Execution).
56+
- **Priority**: Shows the priority level (e.g., Urgent, High, Medium, Low, or None).
57+
- **Team composition**: See the number of **Members** involved and the assigned Project **Lead**.
58+
- **Timeline**: Manage and monitor **Start date** and **Due date** for the project.
59+
60+
## Project updates
61+
Share project status using updates. This helps keep your team informed and create a timeline of project progress.
62+
63+
### Enable project updates
64+
65+
Go to your [project's settings](/core-concepts/projects/overview#project-settings) and turn on **Project Updates**.
66+
67+
![Turn on project updates](https://media.docs.plane.so/projects/turn-on-project-updates.webp#center)
68+
69+
### Add project updates
70+
71+
1. Select the tab with rocket icon in the side panel.
72+
2. Click the **Add an Update** button.
73+
2. Select the status. Each update can be marked as:
74+
- 🚀 **On Track** - Project is progressing as planned
75+
- ⚠️ **At Risk** - There are potential issues that need attention
76+
-**Off Track** - Project has significant blockers or delays
77+
3. Add your update message.
78+
4. Click **Add update**.
79+
80+
![Add project updates](https://media.docs.plane.so/projects/add-project-updates.webp#center)
81+
82+
### Collaborate on updates
83+
84+
- Start threaded discussions around specific updates or tasks.
85+
- Use emoji reactions for quick feedback.
86+
- Mention team members to notify them directly. (coming soon)
87+
88+
## Activity feed
89+
90+
Get real-time updates on project activities, such as task progress, state changes, and new assignments. Updates are listed chronologically, making it easy to follow the project’s history.
91+
92+
![View activity feed](https://media.docs.plane.so/projects/activity-feed.webp#center)

docs/core-concepts/projects/project-states.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: State Of Projects
2+
title: Project states
33
hide_title: true
44
---
55

66
import Tags from '@site/src/components/Tags';
77

88
<div className="tag-wrapper">
9-
# Manage project progress with states
9+
# Manage projects with states
1010
<Tags
1111
tags={[
1212
{ name: "Pro", additionalClass: "pro" }

sidebars.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,12 @@ const sidebars: SidebarsConfig = {
6969
collapsed: false,
7070
label: 'Project + work management',
7171
items: [
72-
'core-concepts/issues/bulk-ops',
73-
'core-concepts/projects/project-states',
7472
'core-concepts/issues/issue-types',
7573
'core-concepts/issues/time-tracking',
74+
'core-concepts/issues/bulk-ops',
7675
'core-concepts/issues/timeline-dependency',
76+
'core-concepts/projects/project-states',
77+
'core-concepts/projects/project-overview',
7778
'core-concepts/export',
7879
],
7980
},

0 commit comments

Comments
 (0)