task/40956-update-docs-for-121

* Update to docs for 12.1

Changed user guide
Established subdirectory "team-planner"
Started editing README for team-planner

* Docs changes for 12.1

Further edits to README of team-planner subdirectory:

-Intro into functionality
-getting started
-more features explained

* Update README.md

* Update readme Team planner

Additional edits to team planner readme file

* Update README.md

* Project status README Update for 12.1

Project status update for 12.1 (WP #34708):
-Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued

Directory: docs/user-guide/projects/project-status/REAMDME.md

* Calendar Module v12.1 Update

Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions

[#36322] Save different views in calendar module

https://community.openproject.org/work_packages/36322

* Update to the Team Planner

Update to the Team Planner as well as functionality of the Planning Calendar.

There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button.

[#40956] Update Docs for 12.1

https://community.openproject.org/work_packages/40956

* Use Cases

I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management.

This is is not associated with a specific work package, but rather a value-add to customers

* Update Images

Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description.

This was done for updates triggered by v12.1:

- User guide -> Modules (update)
- Team planner (new)
- Calendar (update)
- Use cases (new)

* Style guide related changes

Style Guide related changes/adjustments to:

- Docs/User Guide/Team Planner
- Docs/User Guide/Calendar
- Docs/Use Cases/*

Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead

* fix(docs-12.1): typofix in name & url for new section

* fix(docs12.1): resolve review issues

* fix(docs12.1): use relative links for internal doc links

Co-authored-by: as-op <a.sandorf@openproject.com>
pull/10596/head
Fweber1331 3 years ago committed by GitHub
parent eb1fdab53a
commit ce71787d45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/README.md
  2. 4
      docs/development/contribution-documentation/documentation-process/README.md
  3. 22
      docs/development/contribution-documentation/documentation-style-guide/README.md
  4. 4
      docs/development/saml/README.md
  5. 2
      docs/installation-and-operations/system-requirements/README.md
  6. 2
      docs/system-admin-guide/authentication/saml/README.md
  7. 16
      docs/use-cases/README.md
  8. 38
      docs/use-cases/portfolio-management/README.md
  9. BIN
      docs/use-cases/portfolio-management/chose-project.jpg
  10. BIN
      docs/use-cases/portfolio-management/custom-reports.jpg
  11. BIN
      docs/use-cases/portfolio-management/dynamic-data.jpg
  12. BIN
      docs/use-cases/resource-management/Gantt.jpg
  13. 38
      docs/use-cases/resource-management/README.md
  14. BIN
      docs/use-cases/resource-management/configure-view.jpg
  15. BIN
      docs/use-cases/resource-management/display-sums.jpg
  16. BIN
      docs/use-cases/resource-management/resource-management.png
  17. 40
      docs/user-guide/README.md
  18. 24
      docs/user-guide/calendar/README.md
  19. BIN
      docs/user-guide/calendar/calendar-overview.png
  20. BIN
      docs/user-guide/calendar/image-20220321121017281.png
  21. BIN
      docs/user-guide/projects/project-settings/modules/Modules-overview.png
  22. 2
      docs/user-guide/projects/project-settings/modules/README.md
  23. 6
      docs/user-guide/projects/project-status/README.md
  24. BIN
      docs/user-guide/projects/project-status/image-20220214095425579.png
  25. BIN
      docs/user-guide/projects/project-status/image-20220214095510158.png
  26. BIN
      docs/user-guide/projects/project-status/image-20220214100526694.png
  27. BIN
      docs/user-guide/projects/project-status/image-20220214101311648.png
  28. 95
      docs/user-guide/team-planner/README.md
  29. BIN
      docs/user-guide/team-planner/adding-team-members.png
  30. BIN
      docs/user-guide/team-planner/planning-calendar-basics.png
  31. BIN
      docs/user-guide/team-planner/team-planner-overview.png
  32. BIN
      docs/user-guide/team-planner/work-package-strip-detail-view.png
  33. BIN
      docs/user-guide/team-planner/working-with-work-package-strips.png

@ -14,7 +14,7 @@ keywords: help, documentation
## Installation
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](https://www.openproject.org/docs/installation-and-operations/).
Get started with installing and upgrading OpenProject using [our Installation Guide starting point](./installation-and-operations/).
The guides for [manual](./installation-and-operations/installation/manual), [packaged](./installation-and-operations/installation/packaged) and [Docker-based](./installation-and-operations/installation/docker) installations are provided.
@ -35,7 +35,11 @@ The guides for [upgrading](./installation-and-operations/operation/upgrading) ar
## User Guides
Please see our [User Guide pages](https://www.openproject.org/docs/user-guide/) for detailed documentation on the functionality of OpenProject.
Please see our [User Guide pages](./user-guide/) for detailed documentation on the functionality of OpenProject.
## Use Cases
Please see our [Use Cases section](./use-cases/) for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.
## Development

@ -19,7 +19,7 @@ Please note that you find the [OpenProject repository on GitHub](https://github
If you would like to contribute changes to the OpenProject documentation, please follow these steps:
1. [Fork the OpenProject repository](https://www.openproject.org/docs/development/git-workflow/#fork-openproject) and create a local development branch. Include documentation in your branch name.
1. [Fork the OpenProject repository](../../../development/git-workflow/#fork-openproject) and create a local development branch. Include documentation in your branch name.
2. Create your changes in the documentation. It can be found in the folder [docs](https://github.com/opf/openproject/tree/dev/docs). You can work directly in the GitHub markdown files or use e.g. GitHub desktop and a markdown editor like Typora.
If you are not only changing something in an existing documentation page but are adding a new page, please make sure to add metadata. To provide additional directives and useful information, we add metadata to the beginning of each documentation page. This will give you guidance on what information to provide in the metadata:
- Sidebar navigation: You do not have to add anything here. Leave it blank.
@ -28,7 +28,7 @@ If you would like to contribute changes to the OpenProject documentation, please
- Description: description of the content of the page that you are creating. Best is to also include the title name.
- Robots: always add “index, follow” here.
- Keywords: use key words to describe the content of the page, minimum two.
3. [Create a pull request](https://www.openproject.org/docs/development/git-workflow/#create-a-pull-request) on our repository. Make sure you name it accordingly and also include **documentation** in the name.
3. [Create a pull request](../../../development/git-workflow/#create-a-pull-request) on our repository. Make sure you name it accordingly and also include **documentation** in the name.
4. We will evaluate your pull request and changes before we merge it.
If the author or reviewer has any questions, they can use the comments in the pull request.

@ -41,17 +41,17 @@ We aim to have a clear hierarchical structure with meaningful URLs like `https:/
Find an overview of content per folder here:
| **Directory** | **Contents** |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Getting started guide](https://www.openproject.org/docs/getting-started/) | Here you will learn about the first steps with OpenProject. It is a short introduction on registration, sign up, inviting members, starting to set up a project and the most important features work packages, Gantt charts and agile boards. |
| [User guide](https://www.openproject.org/docs/user-guide/) | This guide covers the details of all features and functionalities found in OpenProject. |
| [System admin guide](https://www.openproject.org/docs/system-admin-guide/) | Documentation on how to make changes to settings affecting your entire OpenProject environment. This is relevant for users with administrator rights for the configuration of all modules but also overall, e.g. regarding system settings, authentication or user permissions. |
| [Enterprise guide](https://www.openproject.org/docs/enterprise-guide/) | Here you will find all about the management and administration of your Enterprise cloud and Enterprise on-premises subscription. |
| [FAQs](https://www.openproject.org/docs/faq/) | This is the central overview of frequently asked questions for OpenProject. |
| [Installation and operations guide](https://www.openproject.org/docs/installation-and-operations/) | This guide summarizes the options for getting OpenProject, either hosted or on-premises and what to do if you want to include BIM features in your application. For the on-premises versions you will find all operation and installation instructions. |
| [Release notes](https://www.openproject.org/docs/release-notes/) | OpenProject is regularly upgraded with new features, security updates and more. The release notes inform you about the news in each release. |
| [Development](https://www.openproject.org/docs/development/) | This guide details how to contribute to the code of the OpenProject application. |
| [API](https://www.openproject.org/docs/api/) | This part of the documentation deals with the API specification, what endpoints and functionality are available. |
| **Directory** | **Contents** |
|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Getting started guide](../../../getting-started/) | Here you will learn about the first steps with OpenProject. It is a short introduction on registration, sign up, inviting members, starting to set up a project and the most important features work packages, Gantt charts and agile boards. |
| [User guide](../../../user-guide/) | This guide covers the details of all features and functionalities found in OpenProject. |
| [System admin guide](../../../system-admin-guide/) | Documentation on how to make changes to settings affecting your entire OpenProject environment. This is relevant for users with administrator rights for the configuration of all modules but also overall, e.g. regarding system settings, authentication or user permissions. |
| [Enterprise guide](../../../enterprise-guide/) | Here you will find all about the management and administration of your Enterprise cloud and Enterprise on-premises subscription. |
| [FAQs](../../../faq/) | This is the central overview of frequently asked questions for OpenProject. |
| [Installation and operations guide](../../../installation-and-operations/) | This guide summarizes the options for getting OpenProject, either hosted or on-premises and what to do if you want to include BIM features in your application. For the on-premises versions you will find all operation and installation instructions. |
| [Release notes](../../../release-notes/) | OpenProject is regularly upgraded with new features, security updates and more. The release notes inform you about the news in each release. |
| [Development](../../../development/) | This guide details how to contribute to the code of the OpenProject application. |
| [API](../../../api/) | This part of the documentation deals with the API specification, what endpoints and functionality are available. |

@ -7,11 +7,11 @@ robots: index, follow
# Set up a development SAML idP
**Note:** This guide is targeted only at development with OpenProject. For the SAML configuration guide, please see this URL: https://www.openproject.org/docs/system-admin-guide/authentication/saml/
**Note:** This guide is targeted only at development with OpenProject. For the SAML configuration guide, please see this [here](../../system-admin-guide/authentication/saml/)
To test the SAML integration in your development setup, you can use the following repository: https://github.com/kristophjunge/docker-test-saml-idp
To test the SAML integration in your development setup, you can use the following repository: [docker-test-saml-idp](https://github.com/kristophjunge/docker-test-saml-idp)

@ -90,7 +90,7 @@ Both the package and docker based installations will install and setup the follo
* __Database__: [PostgreSQL](https://www.postgresql.org/) Version >= 13
Starting in OpenProject 12.0, PostgreSQL 13.0 will be a minimum requirement.
PostgreSQL versions 9.6. and up will continue to work, but may result in incompatibilities and degraded performance in the future. We have a [migration guide on how to upgrade to PostgreSQL 13](https://www.openproject.org/docs/installation-and-operations/misc/migration-to-postgresql13/).
PostgreSQL versions 9.6. and up will continue to work, but may result in incompatibilities and degraded performance in the future. We have a [migration guide on how to upgrade to PostgreSQL 13](../../installation-and-operations/misc/migration-to-postgresql13/).
## Client

@ -300,7 +300,7 @@ A: You are able to chose a default direct-login-provider in the `/opt/openprojec
omniauth_direct_login_provider: saml
```
Read more: https://www.openproject.org/docs/installation-and-operations/configuration/#omniauth-direct-login-provider
[Read more](../../../installation-and-operations/configuration/#omniauth-direct-login-provider)

@ -0,0 +1,16 @@
---
sidebar_navigation:
title: Use Cases
priority: 955
description: Step-by-step instruction about various use cases
robots: index, follow
keywords: use-cases
---
# OpenProject Use Cases
| Use Case | Description |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Portfolio Management](portfolio-management) | This guide provides detailed step-by-step instruction on how to set up an overview of your project portfolio and create custom reports using the Project Overview, Wiki and the Rich text (WYSIWYG) editor in OpenProject. |
| [Resource Management](resource-management) | OpenProject does not have the automated functionality to provide detailed resource management or employee work capacity calculations. This guide with detailed step-by-step instructions introduces a workaround that can provide an avenue to accomplish this manually and visually beyond the functionality the Team Planner Module provides. |

@ -0,0 +1,38 @@
---
sidebar_navigation:
title: Portfolio Management and Custom Reporting
priority: 900
description: Step-by-step instruction about portfolio management and custom reporting
robots: index, follow
keywords: use-case, portfolio management
---
# Use Case: Portfolio Management and Custom Reporting Options
Step 1: To view all projects, first select the *project chooser drop-down*, the chose *View all projects*
![Chose project](chose-project.jpg)
Step 2: You can sort and filter this view using custom fields, such as *Initiative* or *Status.* If you have not added useful custom fields, please see [here](../../system-admin-guide/custom-fields/).
Step 3: Press the **floppy disk icon** to save and name your view once you are happy with the information that is displayed. You can also add this view as a favorite to the black bar on the left.
## Creating Custom Reports
You can create advanced project reports by using the same techniques and the print function (**CTRL+P**), then saving as PDF, for example. The print function in OpenProject is optimized for reporting purposes. Only information displayed in the main screen area is included. None of the designs or side or top menus are in it.
For more advanced requirements, using the Wiki is another powerful tool. For more information about how to use the Wiki function, please consult: [Wiki](../../user-guide/wiki/)
The Wiki function allows you to build complete custom reports using embedded work package tables, macros and even embedded calculations.
Here is an example of how a wiki could look:
![Creating custom reports](custom-reports.jpg)
And how the dynamic data, such as calculations, filters, macros and reference language work behind the scenes:
![Dynamic data](dynamic-data.jpg)
For more information about the syntax and how the attributes work [here](../../user-guide/wysiwyg/).
If you like to work with multiple Wiki-based reports, you can create an umbrella Wiki page as a table of content, for example, on which all the other reports are listed. See more info on Wiki and the use of Macros [here](../../user-guide/wiki/).

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

@ -0,0 +1,38 @@
---
sidebar_navigation:
title: Resource Management
priority: 990
description: Step-by-step instruction about resource management
robots: index, follow
keywords: use-case, resource management
---
# Use Case: Resource Management
**Note:** This is a workaround. OpenProject does not have the automated functionality to provide detailed resource management or employee work capacity calculations.
![resource management](resource-management.png)
Step 1: Select a project and go to the work package overview.
Step 2: Either use existing fields, **Estimated time** and **Spent time**, or create custom fields (i.e. **Est. Scope (h)** and **Time spent (h)**)
Step 3: Either insert the standard fields to the view, or insert the custom fields if created in Step 2
Step 4: Then sort and filter all work packages and group by assignee.
Step 5: Save your view
You could also add the Gantt view to add an additional dimension to your overview
![Gantt](Gantt.jpg)
This will provide a rough overview of the various tasks assigned to a specific person or team. Using the Gantt view in addition provides additional overview of how these tasks happen in terms of timelines. It’s a visual way of looking at roughly how many tasks are assigned to an individual and gives you an estimate about the timeline, allowing for adjustments in assignments and timing to be made to balance your resources a little bit. Using filters and the (+) zoom function will help to focus the Gantt view to only tasks that are scheduled in let’s say the next 30 days. These functions can help focus in on showing relevant results only.
You can also use the sum function inside of **[⋮]** -> ***Configure view*** -> ***Display settings*** -> check ***Display Sums*** box:
![Configure view](configure-view.jpg)
![Display sums](display-sums.jpg)
**Limitations:** This workaround can provide an overview of who works on what and when, but it is unfortunately not a solid capacity management tool. It just provides a quick visual estimate.

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

@ -31,22 +31,24 @@ A module in OpenProject encapsulates a specific set of collaboration functionali
Please choose the module or topic you want to learn more about.
| Topic | Content |
| ----------------------------------------- | :----------------------------------------------------------- |
| [Project overview page](project-overview) | How to create a project overview dashboard with important project information? |
| [Activity](activity) | How to find out about the latest activities in a project? |
| [Roadmap](roadmap) | How to create a product roadmap with OpenProject? |
| [Work packages](work-packages) | How to manage your work in a project? |
| [Gantt chart](gantt-chart) | How to create and manage a project plan in a Gantt chart? |
| [Boards](agile-boards) | How to work with Agile boards for agile project management, e.g. Kanban? |
| [Backlogs (Scrum)](backlogs-scrum) | How to manage a Scrum team in OpenProject with a product backlog and taskboard? |
| [Calendar](calendar) | How to display your work in a calendar in OpenProject? |
| [News](news) | How to create and manage News for your projects? |
| [Forums](forums) | How to manage forums to discuss and comment on topics? |
| [Wiki](wiki) | How to create and manage a wiki to collaboratively document and share information? |
| [Time and costs](time-and-costs) | How to track time and costs in OpenProject and report spent time and costs? |
| [Budgets](budgets) | How to create and manage a project budget? |
| [Members](members/) | How to manage Members in a project? |
| [Documents](documents) | How to upload and share documents in OpenProject? |
| [Meetings](meetings) | How to manage meetings to create and share meeting agenda and meeting minutes? |
| [Manage projects](projects) | Edit, create, copy, delete projects and change project settings. |
| Topic | Content |
| ------------------------------------------------------------ | :----------------------------------------------------------- |
| [Project overview page](project-overview) | How to create a project overview dashboard with important project information? |
| [Activity](activity) | How to find out about the latest activities in a project? |
| [Backlogs (Scrum)](backlogs-scrum) | How to manage a Scrum team in OpenProject with a product backlog and taskboard? |
| [Boards](agile-boards) | How to work with Agile boards for agile project management, e.g. Kanban? |
| [Budgets](budgets) | How to create and manage a project budget? |
| [Calendar](calendar) | How to display your work in a calendar in OpenProject? |
| [Documents](documents) | How to upload and share documents in OpenProject? |
| [Forums](forums) | How to manage forums to discuss and comment on topics? |
| [GitHub](../system-admin-guide/integrations/github-integration/) | How to manage GitHub integration? |
| [Meetings](meetings) | How to manage meetings to create and share meeting agenda and meeting minutes? |
| [News](news) | How to create and manage News for your projects? |
| [Team planner](team-planner) | How to use the team planner module? |
| [Time and costs](time-and-costs) | How to track time and costs in OpenProject and report spent time and costs? |
| [Roadmap](roadmap) | How to create a product roadmap with OpenProject? |
| [Wiki](wiki) | How to create and manage a wiki to collaboratively document and share information? |
| [Work packages](work-packages) | How to manage your work in a project? |
| [Gantt chart](gantt-chart) | How to create and manage a project plan in a Gantt chart? |
| [Members](members/) | How to manage Members in a project? |
| [Manage projects](projects) | Edit, create, copy, delete projects and change project settings. |

@ -21,7 +21,7 @@ The calendar shows all of the project's work packages in calendar form.
## Calendar overview
To display the calendar in a project, the module **calendar** needs to be activated in the [project settings](../projects/#project-settings).
To display a calendar in a project, the module **calendar** needs to be activated in the [project settings](../projects/#project-settings).
When you open the calendar, all work packages within the current project are displayed on the calendar, displaying the title of the work package. The colors represent the different [work package types](../../system-admin-guide/manage-work-packages/work-package-types).
@ -29,9 +29,25 @@ The current month is automatically selected. You can change the date range betw
Hovering over one item displays more information to a work package, such as the type, status, start and finish date, assignee and priority, as well as the project to which the work package belongs.
Click on one item to open the work package details or to edit an item.
Click on any item to open the work package details or to edit an item.
![calendar](1568639577828.png)
![Calendar overview](calendar-overview.png)
The numbers in the instruction below correspond to the numbers in the image above:
1. Edit/change the name of your calendar or add additional calendars. Each calendar can be customized to display work packages from specific project(s). You can further fine-tune the information displayed using the filters.
2. Change your calendar to be private to you or public to your organization: Select the **[⋮] button** -> **Visibility settings**
a. Check the **Public** box to make the calendar visible to your entire organization.
b. Check the **Favored** box to save the calendar to your favorites.
3. Any calendar that has the **Favored** box checked in the "Visibility settings" will be displayed under the **Favorite Views** heading in the menu bar to the left.
4. Any calendar that has the **Public** box checked in the "Visibility settings" will be displayed under the **Public Views** heading in the menu bar to the left.
5. Any calendar that has the **Public** box unchecked in the **Visibility settings** will be considered **Private**, and hence displayed under the **Private Views** heading in the menu bar to the left.
## Filters in calendar
@ -53,7 +69,7 @@ You can display the calendar in a full screen view to eliminate header and proje
Click the **Activate zen mode** button on the top of the calendar.
Click Escape (Esc) to leave the Zen mode.
Click Escape (**Esc**) to leave the Zen mode.
![zen-calendar](zen-calendar.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

@ -12,6 +12,6 @@ To **activate or deactivate modules** in a project select a project from the sel
Setting a check mark next to a project module will activate the module in the project and a new menu item will appear in the project menu on the left.
![select-modules-OpenProject](image-20201005151029444.png)
![Overview of Modules](Modules-overview.png)
Visit our [user guide](../../../#overview-of-modules-in-openproject) overview to get an explanation of the different modules in OpenProject.

@ -14,11 +14,11 @@ The project status serves as an information for yourself and the team if the pro
You can set your project status in the **project settings**. For this, click on **project settings** in the menu on the left and then select the relevant status. To add more information to your project status, you can use the status description directly underneath to manually describe changes, project KPIs etc.
![project-settings-project-status](project-settings-project-status.png)
![image-20220214095510158](image-20220214095510158.png)
Alternatively, you can also set the project status in the **project overview**. If you haven't configured anything yet, the project status widget will be displayed by default and you can set the project status by using the drop down.
![Set-project-status-project-overview](Set-project-status-project-overview.png)
![image-20220214100526694](image-20220214100526694.png)
If the widget is not yet displayed on the project overview, you can add the project status to your **project overview** widget by clicking on **+** at the top right corner. Then you can choose where you would like to position your additional widget by clicking on the respective **+** at the top, bottom, left or right of existing widgets. Then set your project status from the drop down as shown above.
@ -34,7 +34,7 @@ Select **View all projects** from the header menu, it will then open your [proje
![View-all-projects](View-all-projects-4478986.png)
![project-list-project-status](project-list-project-status.png)
![image-20220214101311648](image-20220214101311648.png)
### Project overview

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

@ -0,0 +1,95 @@
---
sidebar_navigation:
title: Team planner
priority: 890
description: Using the team planner in OpenProject.
robots: index, follow
keywords: team planner,planning calendar, resource management
---
# Team planner
The team planner is a module that can assist getting a better overview of which team member is working on what work package at what time. It is also a useful tool to schedule those team members for different tasks on various times.
A few notes:
1. The work package module has to be enabled as a prerequisite for the team planner
2. You can have multiple public, private, as well as favorite team planning calendars. They will all appear in the left menu bar.
| Topic | Content |
|-------------------------------------------------------------------------------------------|:--------------------------------------------|
| [Main view](#main-view-start-a-new-or-select-an-existing-team-planner) | How to start a team planner? |
| [Planning calendar basics](#planning-calendar-basics) | How to navigate the team planner? |
| [Getting started](#getting-started) | How to get started? |
| [Adding team members](#step-1-adding-team-members) | How to add team members? |
| [Adding/working with work package strips](#step-2-addingworking-with-work-package-strips) | How to work with work package strips? |
| [Work package strip detail view](#work-package-strip-detail-view) | How to access the work package detail view? |
| [Removing a work package strip](#removing-a-work-package-strip) | How to remove a work package strip? |
## Main view - Start a new or select an existing Team Planner
![Overview of the team planner](team-planner-overview.png)
1. You can create a new team planner using either the **+ Create** button in the top right near your avatar, or by clicking the
**+ New team planner** button at the bottom of the black menu bar.
2. If you created a team planner before, you can select one of the planners from the list.
3. Team planners with the visibility option **public** selected appear under the **Public Views** heading in the black menu bar.
4. Team planners with the visibility option "public" unselected appear under the **Private Views** heading in the black menu bar. Note: If **public** is not selected, the calendar is automatically **private** and can only be seen by you, not other members.
Both **public** and **private** calendars can be added as a **favored** planner, and would appear under the heading **Favorite Views** in the black menu bar.
## Planning calendar basics
![Overview of the planning calendar basics](planning-calendar-basics.png)
How to navigate the team planner? - The numbers below correspond with the above image:
1. The top header: Click on the top header (where it says **Team planner** in the picture above) to edit the name of your new team planning calendar. The top header is in edit mode by default, so you can just click right on the text. This is where you can give the new team planning calendar its new name. Your new name gets saved automatically by exiting the top header (by clicking somewhere else, for example).
2. Use the **+ add existing** button to add an existing work package to your view. Note: You cannot create new work packages from the team planner module. Create new work packages in the work package module, then select them in the team planner.
3. Add a new team member to you planning calendar using the **+ add assignee**.
3. **Include projects** filter: By default, this filter will only include the current project you are in. You can select additional projects as you see fit by pressing this filter button and check-marking additional projects. The number in the grey bubble inside of this button will indicate the number of projects that are currently selected inside of the filter.
4. There is a filter button by which you can focus what is displayed on your calendar (for example, only certain team members or work packages).
5. This switches you team planning calendar to full screen mode.
6. Saving, renaming and saving a copy (saving as), or deleting can also be accomplished using the **[⋮]** button. This is also where you can modify the visibility options. Select **public** to allow others in your organization that are members of your respective project to see your planning calendar. If **public** is not selected, the calendar is **private** and can only be seen by you, not other members.
7. By default the planning calendar only shows the current week. Use these buttons to toggle between the 1-week and 2-week view.
## Getting started
### Step 1: Adding team members
The first step in setting up your team planning calendar is to add team members. This is done via the **+ add assignee** button in #3 above. Press the **+ add assignee** button, and then simply select the team member(s) from the drop-down list. Clicking on a given assignee's name will open a new window with a quick overview of which projects that member is assigned to.
Repeat this step until all team members relevant for this planner are added, and then save it using the floppy disk icon (adjacent to the top header in #1 above).
**Note: Once you are finished adding members to the planner, click the floppy disk icon in the top header to save.**
![Adding team members](adding-team-members.png)
### Step 2: Adding/working with work package strips
Next, add specific work packages to your planner. Do this by pressing the **+ add existing" button** we introduced in step 2 of the main view overview. Once you press the **+ add existing** button, start typing the name of the work package you are looking to add. Once found, drag & drop the work package strip. Should the work package have a duration exceeding the current 1 or 2 week view, a horizontal scroll bar will display, with which it is possible to scroll to the end date of the longest running work package.
Additional features: You can change the status of a work package, and enter the work package strip detailed view by pressing the info button **(i)** on each respective strip
**Note: You can only add existing work packages here. If you need to create some first, create them in the work package module as new work packages cannot be created from the team planner module.**
![Working with work package strips](working-with-work-package-strips.png)
## Work package strip detail view
Click on any given work package strip to open up a split screen showing the work package detail view.
![Work package strip detail view](work-package-strip-detail-view.png)
## Removing a work package strip
Work package strips are never fully removable, since the planning calendar is simply a view of the information pertaining to a given work package. There are, however, a few options to make the strip disappear from your view:
1. Adding a filter that would exclude that work package.
2. Removing the assignee or changing the assignee to one that has not been added to the planner (and is thus not visible).
3. Changing the start/end dates so the currently visible date range does not fall in between them.

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Loading…
Cancel
Save