diff --git a/docs/user-guide/team-planner/README.md b/docs/user-guide/team-planner/README.md index 64c79e0c99fb..c45e3dcc2eb9 100644 --- a/docs/user-guide/team-planner/README.md +++ b/docs/user-guide/team-planner/README.md @@ -10,11 +10,12 @@ keywords: team planner, planning, calendar, resource management, assign, team vi The team planner module helps you get a complete overview of what each member of your team is working on. You can use it to track the current progress of work packages your team is working on, schedule new tasks, reschedule them or even reassign them to different members. -![Example team planner showing a two-week view of work packages assigned to team members](TeamPlanner-12.4-twoWeeks.png) +![Example team planner showing an eight-week view of work packages assigned to team members](openproject_user_guide_teamplanner_overview.png) Essentially, the team planner is a calendar view with an assignee column on the left side. Each work package assigned to a team member will appear as a card that spans a certain duration (start date to finish date). These cards can be moved, stretched, shortened or removed to organize the planning of your team. -> **Note**: Team planner is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free community edition is easy and helps support OpenProject. +> [!NOTE] +> Team planner is an Enterprise add-on and can only be used with [Enterprise cloud](../../enterprise-guide/enterprise-cloud-guide/) or [Enterprise on-premises](../../enterprise-guide/enterprise-on-premises-guide/). An upgrade from the free community edition is easy and helps support OpenProject. To use this module, you must have the work packages module enabled. @@ -32,19 +33,20 @@ To use this module, you must have the work packages module enabled. Clicking on the **Team planners** entry on the left sidebar takes you to the team planner module with a list of all existing team planners: -![A screenshot of a list of team planners visible after clicking on Team Planners on the left-hand menu](TeamPlanner-12.4-listAllAvailable.png) +![A screenshot of a list of team planners visible after clicking on Team Planners on the left-hand menu](openproject_user_guide_teamplanner_overview_explained.png) 1. You can create a new team planner using either the **+ Team planner** button in the top right near your avatar or at the bottom of the left menu bar. - 2. Click on an existing (saved) team planner to open it. -3. Team planners with *public* visibility settings appear under the **Public** heading in the menu bar. -4. New team planners by default appear under the **Private** heading in the left menu bar. These are visible only to you. +3. Team planners marked as *favorite* under visibility settings appear under the **Favorite** heading in the menu bar. +4. Team planners with *public* visibility settings appear under the **Public** heading in the menu bar. +5. New team planners by default appear under the **Private** heading in the left menu bar. These are visible only to you. -> **Info**: Both *public* and *private* team planners can be added as **favored** planners; they will then appear under the **Favorite** heading in the menu bar. +> [!TIP] +> Both *public* and *private* team planners can be added as **favored** planners. ## Team planner basics -![A screenshot of an example team planner with different functions highlighted](TeamPlanner-12.4-oneWeek.png) +![A screenshot of an example team planner with different functions highlighted](openproject_user_guide_teamplanner_detailed_view_explained.png) A team planner has a number of features numbered 1 to 8 in the above screenshot: @@ -57,7 +59,8 @@ A team planner has a number of features numbered 1 to 8 in the above screenshot: 7. The **\[⋮\]** (more) button gives you additional options, such as saving, renaming and saving a copy (saving as), or deleting the team planner. This is also where you can modify the visibility options. 8. By default the team planner only shows the [work week](../../system-admin-guide/calendars-and-dates/#working-days-and-hours) (week excluding the weekend and non-working days). Use the drop down to toggle between work week, 1-week, 2-week, 4-week or 8-week views. With the arrows you can navigate the weeks back and forth. The Today button brings you to the current week. -> **Note**: The team planner will highlight non-working days in the calendar with a darker background color. By default, a work package cannot be dragged or resized such that it begins or ends on these days unless the "Working days only" switch is turned off for that work package. To learn how to do this, refer to the documentation on [Working days and duration](../work-packages/set-change-dates/#working-days-and-duration). +> [!TIP] +> The team planner will highlight non-working days in the calendar with a darker background color. By default, a work package cannot be dragged or resized such that it begins or ends on these days unless the "Working days only" switch is turned off for that work package. To learn how to do this, refer to the documentation on [Working days and duration](../work-packages/set-change-dates/#working-days-and-duration). ## Add team members and work packages @@ -65,13 +68,13 @@ A team planner has a number of features numbered 1 to 8 in the above screenshot: When you create a new team planner, it will be empty, like so: -![An example of a newly-created empty team planner](TeamPlanner-12.4-emptyNew.png) +![An example of a newly-created empty team planner in OpenProject](openproject_user_guide_teamplanner_new_unnamed_empty.png) -The first step in setting up your team planning calendar is to add team members. To do so, click on the **+ Add assignee** button then search for the team member you would like to add from the the drop-down list (1). This will add a new row to the calendar view for that team member. +The first step in setting up your team planning calendar is to add team members. To do so, click on the **+ Assignee** button then search for the team member you would like to add from the the drop-down list (1). This will add a new row to the calendar view for that team member. Repeat this step until all relevant team members are added and then save it using the floppy disk icon in the top header (2). -![Adding team members](TeamPlanner-12.4-addAssignee.png) +![Adding team members to a team planner in OpenProject](openproject_user_guide_teamplanner_add_assignee.png) If you need to remove a member from this list, hover over their name and click on the **X button** that appears next to their name. (This action simply removes the row and does not affect the user's status in the project). @@ -85,13 +88,14 @@ Next, you can add existing work packages to your planner. You can do this by eit You can create a new work package for a particular member of your team by clicking on a cell in that team member's assignee row. -> **Note:** You can also click and drag across a date range to create a work package that spans those dates. The first square will be the start date and the last one the finish date. +> [!TIP] +> You can also click and drag across a date range to create a work package that spans those dates. The first square will be the start date and the last one the finish date. -![Creating a new work package by clicking and dragging across multiple day cells](TeamPlanner-12.4-newTask-drag.png) +![Creating a new work package by clicking and dragging across multiple day cells](openproject_user_guide_teamplanner_add_task_select_row.png) A **new work package dialog** will open. The assignee, start and finish dates will already be set based on where you clicked to create the work package. You can add any additional details, such as subject, work package type, a description and add attachments. Scrolling further down on the split screen also gives you access to other attributes such as cost and time and custom fields that might exist. -![An example of the new work package split screen view](TeamPlanner-12.4-newTask-splitScreen.png) +![An example of the new work package split screen view](openproject_user_guide_teamplanner_add_task.png) #### Add an existing work package @@ -99,15 +103,16 @@ If you would like to take an existing work package and assign it to your team me Start by pressing the **+ Add existing** button below the name of the team planner and search for the work package you would like to add. Once you find it, drag and drop the work package card to the calendar, depending to whom you would like to assign it, and to which start date. The finish date will automatically be derived based on the duration of the work package. -> **Info:** Scheduling tasks by adding existing work packages is easier in the one or two week view, especially if you have work packages that can span a weekend. +> [!NOTE] +> Scheduling tasks by adding existing work packages is easier in the one or two week view, especially if you have work packages that can span a weekend. -![Searching for existing work packages to add to the team planner](TeamPlanner-12.4-addExisting.png) +![Searching for existing work packages to add to the team planner](openproject_user_guide_teamplanner_add_existing_task.png) Sometimes, it is not possible to assign an existing work package to a particular team member for a variety of reasons: they might not be a member of the project the selected work package belongs to, might not have the necessary permissions, or you yourself might not have the necessary permissions to edit the dates or the assignee for that work package. In this case, a small error message will indicate that the operation was not successful. #### Move and resize a work package -![Hover on a work package to see drag handles](TeamPlanner-12.4-hoverWorkPackageCard-dragHandles.png) +![Hover on a work package to see drag handles](openproject_user_guide_teamplanner_task_drag_handles.png) The team planner allows you to quickly re-schedule and re-assign work packages cards: @@ -116,7 +121,8 @@ The team planner allows you to quickly re-schedule and re-assign work packages c - To change finish date only, hover over the work package and **click and drag the *drag handles* on the right edge** (2) of the work package card to shorten or lengthen the total duration. - To maintain duration but to move the work package forwards or backwards in time, **simply click and drag the work package horizontally**. -> **Info**: Work packages can also expand and retract in width depending on how many non-working days are spanned (for example, a 3-day task starting on Thursday and ending on Monday will spread across 5 calendar days; dragging that same work package so that it starts on a Tuesday and ends on a Thursday means that it will spread across 3 calendar days. In both cases, the duration remains 3 days. +> [!NOTE] +> Work packages can also expand and retract in width depending on how many non-working days are spanned (for example, a 3-day task starting on Thursday and ending on Monday will spread across 5 calendar days; dragging that same work package so that it starts on a Tuesday and ends on a Thursday means that it will spread across 3 calendar days. In both cases, the duration remains 3 days. Sometimes, it is not possible to modify the dates or the assignee of work packages for a variety of reasons. It could be, for example, because you might not have the necessary permissions to make that change or because existing relations make it impossible. In such cases, an error message will appear on the top of the screen to let you know that the change was not possible. @@ -126,11 +132,11 @@ When you want to understand what a team member is working on, or want to re-sche To open the work package details in split screen, hover on a work package card and click on the **i icon** (information): -![Click on the i icon in a work package card to open details in split screen view](TeamPlanner-12.4-hoverWorkPackageCard.png) +![Click on the i icon in a work package card to open details in split screen view](openproject_user_guide_teamplanner_task_info_icon.png) This will open the work package details in split screen view, where you can view and edit all work package attributes, consult recent activity, view linked files and link new or attach ones and view and create work package relations. -![An example of the work package detail view in split screen](TeamPlanner-12.4-splitScreen.png) +![An example of the work package detail view in split screen](openproject_user_guide_teamplanner_task_splitscreen.png) ## Remove a work package @@ -142,4 +148,4 @@ Since the team planner is simply a view that displays work packages for certain Alternatively, the team planner offers an easy way to remove a work package by combining 2 and 3 in one action. When you start dragging a work package, a *remove drop zone* appears at the bottom of the team planner. You can drag a work package card to that drop zone to clear the assignee, start date and finish date attributes in one go. -![The remove drop zone appears when dragging a work package card](TeamPlanner-12.4-removeAssigneeDates.png) +![The remove drop zone appears when dragging a work package card](openproject_user_guide_teamplanner_delete_task.png) diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_assignee.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_assignee.png new file mode 100644 index 000000000000..a13a29935196 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_assignee.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_existing_task.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_existing_task.png new file mode 100644 index 000000000000..63a6191e78b3 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_existing_task.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task.png new file mode 100644 index 000000000000..adf25121631b Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task_select_row.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task_select_row.png new file mode 100644 index 000000000000..f2be4b6446e2 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_add_task_select_row.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_delete_task.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_delete_task.png new file mode 100644 index 000000000000..5c5363da8a69 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_delete_task.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_detailed_view_explained.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_detailed_view_explained.png new file mode 100644 index 000000000000..1d2dda9c1d2d Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_detailed_view_explained.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_new_unnamed_empty.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_new_unnamed_empty.png new file mode 100644 index 000000000000..58b792b368c3 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_new_unnamed_empty.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview.png new file mode 100644 index 000000000000..c8e5bba4c372 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview_explained.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview_explained.png new file mode 100644 index 000000000000..a9cbc585392a Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_overview_explained.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_drag_handles.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_drag_handles.png new file mode 100644 index 000000000000..60ad059c639b Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_drag_handles.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_info_icon.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_info_icon.png new file mode 100644 index 000000000000..0af81c4753a3 Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_info_icon.png differ diff --git a/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_splitscreen.png b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_splitscreen.png new file mode 100644 index 000000000000..8f6d053cb23d Binary files /dev/null and b/docs/user-guide/team-planner/openproject_user_guide_teamplanner_task_splitscreen.png differ