From 4f21920b2d57c41ad2b4c15033074665e62b70ca Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 2 Jan 2025 19:34:57 +0530 Subject: [PATCH 1/3] Add page for Project Overview --- .../projects/project-overview.mdx | 85 +++++++++++++++++++ sidebars.ts | 1 + 2 files changed, 86 insertions(+) create mode 100644 docs/core-concepts/projects/project-overview.mdx diff --git a/docs/core-concepts/projects/project-overview.mdx b/docs/core-concepts/projects/project-overview.mdx new file mode 100644 index 0000000..a35122d --- /dev/null +++ b/docs/core-concepts/projects/project-overview.mdx @@ -0,0 +1,85 @@ +--- +title: Project Overview +hide_title: true +--- + +import Tags from '@site/src/components/Tags'; + +
+# Track project progress at a glance + +
+ +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. +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 Overview](https://media.docs.plane.so/projects/project-overview.webp#center) + +## Project properties + +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**. + +### Collaborate on updates + +- Start threaded discussions around specific updates or tasks. +- Mention team members to notify them directly. +- Use emoji reactions for quick feedback. + +## 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. \ No newline at end of file diff --git a/sidebars.ts b/sidebars.ts index b55d376..97aed62 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -74,6 +74,7 @@ const sidebars: SidebarsConfig = { 'core-concepts/issues/issue-types', 'core-concepts/issues/time-tracking', 'core-concepts/issues/timeline-dependency', + 'core-concepts/projects/project-overview', 'core-concepts/export', ], }, From e093ccf6e767844ab9e8217a6540f7c4c39d60c9 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 16 Jan 2025 18:10:51 +0530 Subject: [PATCH 2/3] Added images --- .../core-concepts/projects/project-overview.mdx | 17 ++++++++++++----- docs/core-concepts/projects/project-states.mdx | 2 +- sidebars.ts | 4 ++-- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/core-concepts/projects/project-overview.mdx b/docs/core-concepts/projects/project-overview.mdx index a35122d..8909e41 100644 --- a/docs/core-concepts/projects/project-overview.mdx +++ b/docs/core-concepts/projects/project-overview.mdx @@ -1,5 +1,5 @@ --- -title: Project Overview +title: Project overview hide_title: true --- @@ -36,6 +36,9 @@ The header includes the project details and quick access to essential actions. ## 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. @@ -43,10 +46,10 @@ This helps to identify overdue tasks and track progress over time. Task status b - **Started**: Tasks currently in progress. - **Completed**: Tasks that are done. -![Project Overview](https://media.docs.plane.so/projects/project-overview.webp#center) - ## 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). @@ -74,12 +77,16 @@ Go to your [project's settings](/core-concepts/projects/overview#project-setting 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. -- Mention team members to notify them directly. - 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. \ No newline at end of file +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) diff --git a/docs/core-concepts/projects/project-states.mdx b/docs/core-concepts/projects/project-states.mdx index e9aa949..6a4fa5a 100644 --- a/docs/core-concepts/projects/project-states.mdx +++ b/docs/core-concepts/projects/project-states.mdx @@ -1,5 +1,5 @@ --- -title: State Of Projects +title: Project states hide_title: true --- diff --git a/sidebars.ts b/sidebars.ts index 97aed62..a8f48a3 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -69,11 +69,11 @@ 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', ], From 9ee5a99e9419a0fcc5dfbee6c40a8a111530b755 Mon Sep 17 00:00:00 2001 From: danciaclara Date: Thu, 16 Jan 2025 18:20:27 +0530 Subject: [PATCH 3/3] minor fixes --- docs/core-concepts/projects/project-overview.mdx | 2 +- docs/core-concepts/projects/project-states.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/core-concepts/projects/project-overview.mdx b/docs/core-concepts/projects/project-overview.mdx index 8909e41..c751289 100644 --- a/docs/core-concepts/projects/project-overview.mdx +++ b/docs/core-concepts/projects/project-overview.mdx @@ -6,7 +6,7 @@ hide_title: true import Tags from '@site/src/components/Tags';
-# Track project progress at a glance +# Monitor project progress at a glance -# Manage project progress with states +# Manage projects with states