Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project Overview #197

Merged
merged 4 commits into from
Jan 16, 2025
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
92 changes: 92 additions & 0 deletions docs/core-concepts/projects/project-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
title: Project overview
hide_title: true
---

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

<div className="tag-wrapper">
# Monitor project progress at a glance
<Tags
tags={[
{ name: "Pro", additionalClass: "pro" }
]}
/>
</div>

Without a centralized dashboard, teams often face challenges like fragmented information, inefficient progress tracking, and communication gaps.

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.

## Access Project Overview

Navigate to **Issues** under your project and click **Overview** on the top bar.

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

## Project header

The header includes the project details and quick access to essential actions.

- Add a custom banner and project icon to personalize your dashboard.
- Write key details about your project plan, goals, and success metrics, helping your team stay aligned and focused.
- Attach links or resources directly to the dashboard.

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

## Project metrics
You can view overall project completion percentages. Metrics are displayed visually with status bars to help identify bottlenecks.

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

This helps to identify overdue tasks and track progress over time. Task status breakdown:
- **Overdue**: Tasks past their due dates.
- **Backlog**: Tasks that are planned but not yet prioritized.
- **Unstarted**: Tasks yet to begin.
- **Started**: Tasks currently in progress.
- **Completed**: Tasks that are done.

## Project properties

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

Quickly view and edit project properties in the info icon tab on the side panel.

- **State**: Displays the current state of the project (e.g., Execution).
- **Priority**: Shows the priority level (e.g., Urgent, High, Medium, Low, or None).
- **Team composition**: See the number of **Members** involved and the assigned Project **Lead**.
- **Timeline**: Manage and monitor **Start date** and **Due date** for the project.

## Project Updates
Share project status using updates. This helps keep your team informed and create a timeline of project progress.

### Enable project updates

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

![Turn on project updates](https://media.docs.plane.so/projects/turn-on-project-updates.webp#center)

### Add project updates

1. Select the tab with rocket icon in the side panel.
2. Click the **Add an Update** button.
2. Select the status. Each update can be marked as:
- 🚀 **On Track** - Project is progressing as planned
- ⚠️ **At Risk** - There are potential issues that need attention
- ❗ **Off Track** - Project has significant blockers or delays
3. Add your update message.
4. Click **Add update**.

![Add project updates](https://media.docs.plane.so/projects/add-project-updates.webp#center)

### Collaborate on updates

- Start threaded discussions around specific updates or tasks.
- Use emoji reactions for quick feedback.
- Mention team members to notify them directly. (coming soon)

## Activity feed

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.

![View activity feed](https://media.docs.plane.so/projects/activity-feed.webp#center)
4 changes: 2 additions & 2 deletions docs/core-concepts/projects/project-states.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: State Of Projects
title: Project states
hide_title: true
---

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

<div className="tag-wrapper">
# Manage project progress with states
# Manage projects with states
<Tags
tags={[
{ name: "Pro", additionalClass: "pro" }
Expand Down
5 changes: 3 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,12 @@ const sidebars: SidebarsConfig = {
collapsed: false,
label: 'Project + work management',
items: [
'core-concepts/issues/bulk-ops',
'core-concepts/projects/project-states',
'core-concepts/issues/issue-types',
'core-concepts/issues/time-tracking',
'core-concepts/issues/bulk-ops',
'core-concepts/issues/timeline-dependency',
'core-concepts/projects/project-states',
'core-concepts/projects/project-overview',
'core-concepts/export',
],
},
Expand Down