Save changes

pull/7908/head
birthe 5 years ago
commit cf1224aab6
  1. BIN
      .DS_Store
  2. BIN
      help/.DS_Store
  3. 4
      help/getting-started/README.md
  4. 18
      help/getting-started/boards-introduction.md
  5. 8
      help/getting-started/gantt-chart-introduction.md
  6. 6
      help/getting-started/invite-members.md
  7. 22
      help/getting-started/my-account.md
  8. 24
      help/getting-started/my-page.md
  9. 10
      help/getting-started/openproject-introduction.md
  10. 2
      help/getting-started/projects.md
  11. 6
      help/getting-started/sign-in-registration.md
  12. 2
      help/getting-started/work-packages-introduction.md

BIN
.DS_Store vendored

Binary file not shown.

BIN
help/.DS_Store vendored

Binary file not shown.

@ -2,7 +2,7 @@
Welcome to the OpenProject **Getting Started guide**. Welcome to the OpenProject **Getting Started guide**.
Here you will learn about the **first steps with OpenProject**. If you need more detailed explanations of all features, please visit the respective section in our [user guide](../user-guide/). Here you will l [openproject-introduction.md](openproject-introduction.md) earn about the **first steps with OpenProject**. If you need more detailed explanations of all features, please visit the respective section in our [user guide](../user-guide/).
## Overview ## Overview
@ -20,7 +20,7 @@ Here you will learn about the **first steps with OpenProject**. If you need more
## 5 steps to get started ## 5 steps to get started
Watch a short 3 minute video to get started with OpenProject in 5 easy steps: Watch a short 3 minute introduction video to get started with OpenProject in 5 easy steps:
1. Create a project 1. Create a project
2. Add team members 2. Add team members

@ -7,9 +7,9 @@ keywords: invite members
# Introduction to agile Boards (Premium feature) # Introduction to agile Boards (Premium feature)
In this document you will get a first introduction to the Boards in OpenProject, i.e. to use a Kanban board to manage your tasks in an agile way. In this document you will get a first introduction to the Boards in OpenProject, i.e. how to use a Kanban board to manage your tasks in an agile way.
To find out more about the functionalities for Boards, please visit our [user guide for Gantt charts](/user-guide/boards). To find out more about the functionalities of Boards, please visit our [user guide for Gantt charts](/user-guide/boards).
| Feature | Documentation for | | Feature | Documentation for |
| ---------------------------------------------------------- | ------------------------------------------ | | ---------------------------------------------------------- | ------------------------------------------ |
@ -20,18 +20,18 @@ To find out more about the functionalities for Boards, please visit our [user gu
Agile Boards in OpenProject support teams in their agile project management methodology, e.g. Scrum or Kanban. Agile Boards in OpenProject support teams in their agile project management methodology, e.g. Scrum or Kanban.
You can create as many flexible boards with lists and cards on it. A list usually represent a workflow, e.g. status or versions of a work package. The cards are work packages, e.g. tasks, on this list. You can create as many flexible boards as you want with both lists and cards on it. A list usually represents a workflow, e.g. status or versions of a work package. The cards are work packages, e.g. tasks, on this list.
<iframe width="560" height="315" src="https://www.youtube.com/embed/Z7iE_BNCDus" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube.com/embed/Z7iE_BNCDus" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
## Manage your work in a Board ## Manage your work in a Board
To manage your work in an agile board, open the Boards module in OpenProject in the project menu. To manage your work in an agile board, open the Boards module in the project menu.
1. Choose a board from the list where you want to work on. Open it by double click on the board's titel. 1. Choose a board from the list where you want to work on. Open it by double clicking on the board's titel.
2. You can prioritize cards within a list with drag and drop 2. You can prioritize cards within a list via drag and drop.
3. You can add a card to a new list with drag and drop. 3. You can add a card to a new list in the sae way.
4. You can edit the details of a card by **double click** on the card. 4. You can edit the details of a card by **double click**ing on the card.
5. The arrow brings you back to the boards view. 5. Finally the arrow brings you back to the boards view.

@ -22,7 +22,7 @@ To find out more about the functionalities for Gantt charts, please visit our [u
With Gantt charts in OpenProject you can create and manage a project plan and share the information with your team. You can schedule your tasks and visualize the required steps to complete your project. As a project manager you are directly informed about delays in your project and can act accordingly. With Gantt charts in OpenProject you can create and manage a project plan and share the information with your team. You can schedule your tasks and visualize the required steps to complete your project. As a project manager you are directly informed about delays in your project and can act accordingly.
The dynamic Gantt chart in OpenProject displays the phases and milestones in your project as well as relationships between them. Each element in the timeline has a start date and a due date so you are always informed about the current status. The dynamic Gantt chart in OpenProject displays the phases and milestones in your project as well as relationships between them. Each element in the timeline has both a start as well as a due date so you are always informed about the current status.
## Activate the Gantt chart view ## Activate the Gantt chart view
@ -46,7 +46,7 @@ You can create new work packages directly in the list by clicking on the **creat
Click in the Gantt chart to add an element in the project plan. Click in the Gantt chart to add an element in the project plan.
You can change the duration or move the element in the project plan with drag and drop. You can change the duration or move the element in the project plan via drag and drop.
![create-projectplan](create-projectplan-1571743591204.gif) ![create-projectplan](create-projectplan-1571743591204.gif)
@ -54,8 +54,8 @@ You can change the duration or move the element in the project plan with drag an
You can edit a project plan by clicking directly in the list and change work package attributes, e.g. Status, Priority or Assignee. You can edit a project plan by clicking directly in the list and change work package attributes, e.g. Status, Priority or Assignee.
To change the start and end date or the duration of a work package, click directly in the Gantt chart and change it with drag and drop. To change the start and end date or the duration of a work package, click directly in the Gantt chart and change it via drag and drop.
All changes will also be tracked in the work packges [Activity](/user-guide/#activity). All changes will also be tracked in the work packages [Activity](/user-guide/#activity).
![edit-projectplan](edit-projectplan.gif) ![edit-projectplan](edit-projectplan.gif)

@ -24,13 +24,13 @@ In order to see a project and work in it, you have to be a member of a project.
To add existing users to a project, [select the project](./project-admin-guide/#select-a-project) where you want to add members. In the project menu on the left, select the **Members** menu item. To add existing users to a project, [select the project](./project-admin-guide/#select-a-project) where you want to add members. In the project menu on the left, select the **Members** menu item.
In the Members list you will get an overview of which users are already a member of this project. In the Members list you will get an overview of the current members of this project.
![projet-members](1566223836715.png) ![projet-members](1566223836715.png)
Click the green **+ Member** button in the top right corner. Click the green **+ Member** button in the top right corner.
Type in the name of the team member which you want to add. You can also choose several at a time. **Assign a role** to the new member(s) and click the blue **Add** button. Type in the name of the team member which you want to add. You can also choose several members at once. **Assign a role** to the new member(s) and click the blue **Add** button.
![add-members](1566224199456.png) ![add-members](1566224199456.png)
@ -40,7 +40,7 @@ You can also invite new members who have not yet an OpenProject account. [Select
Type in the email address of the new member. If OpenProject does not find an existing user, the **Invite** information will automatically be put before the email address. Assign a role to this new member and click the blue **Add** button. Type in the email address of the new member. If OpenProject does not find an existing user, the **Invite** information will automatically be put before the email address. Assign a role to this new member and click the blue **Add** button.
An e-mail invitation will be sent out to the user with a link to [create an account](#create-a-new-account) in OpenProject. An e-mail invitation will be sent out to the user with a link to [create an account](#create-a-new-account) for OpenProject.
![invite-new-members](1566224961670.png) ![invite-new-members](1566224961670.png)

@ -17,7 +17,7 @@ Change your personal settings in My Account. Here you can adapt, e.g. the langua
| [Profile settings: change your language, time zone or display of comments](#profile-settings:-change-your-language,-time-zone-or-display-of-comments) | How to change the language, time zone or display of comments in OpenProject? | | [Profile settings: change your language, time zone or display of comments](#profile-settings:-change-your-language,-time-zone-or-display-of-comments) | How to change the language, time zone or display of comments in OpenProject? |
| [Two-factor authentication](#two-factor-authentication) | How to set up a two-factor authentication? | | [Two-factor authentication](#two-factor-authentication) | How to set up a two-factor authentication? |
| [Email notifications](#email-notifications) | How to change email notifications sent by OpenProject? | | [Email notifications](#email-notifications) | How to change email notifications sent by OpenProject? |
| [Set an Avatar](#set-an-avatar) | How to set an Avatar in OpenProject to change the profile picture? | | [Set an Avatar](#set-an-avatar) | How to set an Avatar in OpenProject and change the profile picture? |
| [Delete account](#delete-account) | How to delete my own account? | | [Delete account](#delete-account) | How to delete my own account? |
## Open My Account settings ## Open My Account settings
@ -30,7 +30,7 @@ Choose **My account**.
## Change password ## Change password
In order to reset your password, navigate tothe My Account section and choose **Change passwor**d in the menu. In order to reset your password, navigate to the My Account section and choose **Change passwor**d in the menu.
Enter your current password. Enter your current password.
@ -110,8 +110,8 @@ Or you can register to use an app-based authenticator, such as Google Authentica
To register your phone number to receive a one time password via SMS, click on the **Register device** button under the **Use your mobile phone** section. To register your phone number to receive a one time password via SMS, click on the **Register device** button under the **Use your mobile phone** section.
- Choose an identifier how you want you phone to be named. - Choose an identifier how you want your phone to be named.
- Enter you phone number in the following format. - Enter your phone number in the following format.
![two-factor authentication](1572878991958.png) ![two-factor authentication](1572878991958.png)
@ -146,14 +146,14 @@ You can choose to receive emails for any events in certain projects or for no ev
![Email notifications](1571835165758.png) ![Email notifications](1571835165758.png)
The following options are available for the email notifications (ranging from receiving emails on a lot of events to receiving no emails at all): The following options are available for the email notifications (ranging from receiving emails on a lot of events to receiving no emails at all):
- **For any event on all my projects** – When selecting this option you receive an email for any action in the projects you are a member of (independent of whether or not you are involved in this action). This can be useful for managers who want to always stay up to date of all developments without having to log into OpenProject. This setting will typically lead to receiving a lot of emails. - **For any event on all my projects** – When selecting this option you receive an email for any action in the projects you are a member of (independent of whether or not you are involved in this action). This can be useful for managers who want to always stay up to date of all developments without having to log into OpenProject. This setting will typically lead to receiving a lot of emails.
- **For any event on the selected projects only** – This options lets you choose the projects for which you receive all email updates. In addition, you receive email notifications from other projects about activities you watch or are involved in (e.g. when you are the author, assignee or responsible of a work package.). This is useful for project managers who need to be informed about any change in the project(s) they manage but who want to only receive email notifications from other projects if the activities directly affect them. - **For any event on the selected projects only** – This option lets you choose the projects for which you receive all email updates. In addition, you receive email notifications from other projects about activities you watch or are involved in (e.g. when you are the author, assignee or responsible of a work package.). This is useful for project managers who need to be informed about any change in the project(s) they manage but who want to only receive email notifications from other projects if the activities directly affect them.
- **Only for things I watch or I’m involved in** – This is the default option for new users (unless configured differently in the [administration (email notification settings)](https://www.openproject.org/help/system-settings/email-notification-settings/)). Users with this setting receive emails for activities in which they are involved (e.g. if they watch an activity, are the author, assignee or responsible). This option is usually the best option since users only get email updates about activities in which they are involved therefore reducing the number of emails they receive. - **Only for things I watch or I’m involved in** – This is the default option for new users (unless configured differently in the [administration (email notification settings)](https://www.openproject.org/help/system-settings/email-notification-settings/)). Users with this setting receive emails for activities in which they are involved (e.g. if they watch an activity, are the author, assignee or responsible). This option is usually the best option since users only get email updates about activities in which they are involved therefore reducing the number of emails they receive.
- **Only for things I am assigned to** – With this email setting you only receive email updates of activities to which you are assigned (e.g. work packages). This is useful for users who want to only be notified via email if they are actively working on a task, not if they are responsible for or watching the activity. - **Only for things I am assigned to** – With this email setting you only receive email updates of activities to which you are assigned (e.g. work packages). This is useful for users who want to only be notified via email if they are actively working on a task, not if they are responsible for or watching the activity.
- **Only for things I am the owner of** – When you select this setting you only receive email updates for activities which you created (e.g. work packages, wiki pages). This makes sense if you are not actively involved in a project but want to only be notified if your activities are updated. - **Only for things I am the owner of** – When you select this setting you only receive email updates for activities which you created (e.g. work packages, wiki pages). This makes sense if you are not actively involved in a project but want to only be notified if your activities are updated.
- **No event** – With this setting you receive no emails at all. You need to log into OpenProject to verify the status of your tasks. Unless you check the status within OpenProject very frequently or are not actively involved in any project this setting is typically too restrictive. - **No event** – With this setting you receive no emails at all. You need to log into OpenProject to verify the status of your tasks. Unless you check the status within OpenProject very frequently or are not actively involved in any project this setting is typically too restrictive.
By default you do not receive any email notifications about your own changes. If you want to receive emails for your own changes (e.g. to make sure you that emails for changes you made have been sent), activate the checkbox **I want to be notified of changes that I make myself**. By default you do not receive any email notifications about your own changes. If you want to receive emails for your own changes (e.g. to make sure you that emails for changes you made have been sent), activate the checkbox **I want to be notified of changes that I make myself**.

@ -9,18 +9,18 @@ keywords: my page
The My Page is your personal dashboard with important overarching project information, such as work package reports, news, spent time, or a calendar. It can be configured to your specific needs. The My Page is your personal dashboard with important overarching project information, such as work package reports, news, spent time, or a calendar. It can be configured to your specific needs.
| Feature | Documentation for | | Feature | Documentation for |
| ------------------------------------------------------------ | ------------------------------------------------------ | | ------------------------------------------------------------ | -------------------------------------------------- |
| [My Page introduction](#my-page-introduction) | What is the My Page and what can I do with it? | | [My Page introduction](#my-page-introduction) | What is My Page and what can I do with it? |
| [Configure the My Page](#configure-the-my-page) | How to configure the My Page? | | [Configure the My Page](#configure-the-my-page) | How to configure My Page? |
| [Add widgets](#add-widgets) | How to add widgets to the My Page? | | [Add widgets](#add-widgets) | How to add widgets to My Page? |
| [Change position of the widgets](#change-position-of-the-widgets) | How to change the position of a widget on the My Page? | | [Change position of the widgets](#change-position-of-the-widgets) | How to change the position of a widget on My Page? |
| [Change the size of a widget](#change-the-size-of-a-widget) | How to change the size of a widget? | | [Change the size of a widget](#change-the-size-of-a-widget) | How to change the size of a widget? |
| [Remove a widget](#remove-widget) | How to delete a widget on the My Page? | | [Remove a widget](#remove-widget) | How to delete a widget on My Page? |
## My Page introduction ## My Page introduction
The My Page is your personal dashboard where you can display important information of your projects. This personal dashboard contains information from all your projects. The **My page** can be configured according to your preferences. You can include project information, for example the latest news, work packages assigned to you or reported work packages. My Page is your personal dashboard where you can display important information of your projects. This personal dashboard contains information from all your projects. **My page** can be configured according to your preferences. You can include project information, for example the latest news, work packages assigned to you or reported work packages.
You can open your **My page** by clicking on your user avatar in the upper right corner and then selecting **My page** from the dropdown menu. You can open your **My page** by clicking on your user avatar in the upper right corner and then selecting **My page** from the dropdown menu.
@ -36,15 +36,15 @@ As a default, you will see two lists of all **work packages assigned to you** an
### Add widgets ### Add widgets
In order to **add a widget to the My Page**, press the **+** icon on the top right corner of the page. In order to **add a widget to My Page**, press the **+** icon on the top right corner of the page.
The dashboard shows the places where it is possible to add more widgets by displaying **+** icons. The dashboard shows the places where it is possible to add more widgets by displaying **+** icons.
Press a plus icon to add a widget to the My Page at the according place. Press a plus icon to add a widget to My Page at the according place.
![my-page-add-widget](my-page-add-widget.png) ![my-page-add-widget](my-page-add-widget.png)
Once you have chosen the place where to add the new widget on the My Page, you can choose from a number of different widgets that can be included on your dashboard. Once you have chosen the place where to add the new widget on My Page, you can choose from a number of different widgets that can be included on your dashboard.
![my page new widgets](1572883929593.png) ![my page new widgets](1572883929593.png)

@ -16,7 +16,7 @@ Welcome to OpenProject! We are glad to have you here. In this section we will co
| [About OpenProject](#about-openproject) | What is OpenProject? | | [About OpenProject](#about-openproject) | What is OpenProject? |
| [First steps to get started](#first-steps-to-get-started) | The first steps to get started with OpenProject. | | [First steps to get started](#first-steps-to-get-started) | The first steps to get started with OpenProject. |
| [The entire Project Management Life-Cycle](#the-entire-project-management-life-cycle) | Find out more how OpenProject supports the different project phases. | | [The entire Project Management Life-Cycle](#the-entire-project-management-life-cycle) | Find out more how OpenProject supports the different project phases. |
| [OpenProject products](#openproject-products) | What is the differences between the Community, Cloud and Enterprise Edition? | | [OpenProject products](#openproject-products) | What is the difference between the Community, Cloud and Enterprise Edition? |
## About OpenProject ## About OpenProject
@ -50,7 +50,7 @@ The following sections provide links to the documentation for each project phase
| ------------------------------------------------------------ | ------------------------------------------------------------ | | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Project concept and initiation](#project-concept-and-initiation) | Collect ideas and specify project scope and deliverables: set up a project, document initial ideas, project description, invite members. | | [Project concept and initiation](#project-concept-and-initiation) | Collect ideas and specify project scope and deliverables: set up a project, document initial ideas, project description, invite members. |
| [Project definition and planning](#project-definition-and-planning) | Create a project overview with detailed information, set up a project plan, create your roadmap. | | [Project definition and planning](#project-definition-and-planning) | Create a project overview with detailed information, set up a project plan, create your roadmap. |
| [Project launch or execution](#project-launch-or-execution) | Manage all project activities, such as tasks, deliverables, risks, features, bugs, change requests. Use agile boards with your teams. Document meetings, share news. | | [Project launch or execution](#project-launch-or-execution) | Manage all project activities, such as tasks, deliverables, risks, features, bugs, change requests. Use agile boards with your teams, document meetings, share news. |
| [Project performance and control](#project-performance-and-control) | Create and manage project budgets, track and evaluate time and costs. Have custom reports for accurate, current insight into project performance and allocated resources. | | [Project performance and control](#project-performance-and-control) | Create and manage project budgets, track and evaluate time and costs. Have custom reports for accurate, current insight into project performance and allocated resources. |
| [Project close](#project-close) | Document project achievements, lessons learned, best practices and easily summarize the main results of a project. Archive projects for later reference and lessons learned. | | [Project close](#project-close) | Document project achievements, lessons learned, best practices and easily summarize the main results of a project. Archive projects for later reference and lessons learned. |
@ -95,7 +95,7 @@ Create and manage project budgets, track and evaluate time and costs. Have custo
| Features | Documentation for | | Features | Documentation for |
| ----------------------- | ------------------------------------------------------------ | | ----------------------- | ------------------------------------------------------------ |
| Dashboard | Visualize your progress within a project or project overarching (coming soon) | | Dashboard | Visualize your progress within a project or project overarching (coming soon). |
| Budgets | Create and manage budgets in your project. | | Budgets | Create and manage budgets in your project. |
| Time tracking | Track time for any work within your project. | | Time tracking | Track time for any work within your project. |
| Track unit costs | Track unit costs for your project. | | Track unit costs | Track unit costs for your project. |
@ -119,7 +119,7 @@ OpenProject can be used in three different Editions, either on-premise or as sof
![openproject versions](1569586019132.png) ![openproject versions](1569586019132.png)
* [Community Edition](https://www.openproject.org/download-and-installation/): self-installed on-premise. * [Community Edition](https://www.openproject.org/download-and-installation/): self-installed on-premise.
* [Cloud Edition](https://www.openproject.org/hosting/): we host it, inkl. premium features and support. * [Cloud Edition](https://www.openproject.org/hosting/): we host it, incl. premium features and support.
* [Enterprise Edition](https://www.openproject.org/enterprise-edition/): self-hosted version, inkl. premium features and support. * [Enterprise Edition](https://www.openproject.org/enterprise-edition/): self-hosted version, incl. premium features and support.
To compare the features side by side, please visit our [Feature Comparison](https://www.openproject.org/pricing/#features) page. To compare the features side by side, please visit our [Feature Comparison](https://www.openproject.org/pricing/#features) page.

@ -55,7 +55,7 @@ To configure further project information, see the [advanced settings](./project-
### View all projects ### View all projects
To view all your projects where you are a member, click on the **View all projects** link on the Select a project drop-down menu. To view all your projects where you are a member, click on the **View all projects** link on the Select a project drop-down menu.
![view all proejcts](1569490429831.png) ![view all proejcts](1569490429831.png)

@ -27,7 +27,7 @@ Here you will get an overview how to sign in and register to an existing OpenPro
To sign in to an OpenProject installation with an existing account, please enter the URL of your OpenProject in a modern browser, e.g. documentation.openproject.com. To sign in to an OpenProject installation with an existing account, please enter the URL of your OpenProject in a modern browser, e.g. documentation.openproject.com.
Type in your user name and password in the respective fields and click the blue Sign in button. You will then be signed into your OpenProject. Type in your user name and password in the respective fields and click the blue Sign in button. You will then be signed in to your OpenProject environment.
![Sign-in to OpenProject](1565974792215.png) ![Sign-in to OpenProject](1565974792215.png)
@ -47,7 +47,7 @@ If you have activated Two-factor authentication, please enter your second factor
![1566204298041](1566204298041.png) ![1566204298041](1566204298041.png)
Then, you are asked to Create your OpenProject Account. Then, you are asked to create your OpenProject Account.
![Create-account](1566204388512.png) ![Create-account](1566204388512.png)
@ -80,7 +80,7 @@ Make sure to remember your password in order to sign-in again at a later point.
## Reset your password ## Reset your password
If you forgot your password, you can rest your password by clicking the blue **Forgot your password** link directly below the Sign in field. If you forgot your password, you can reset your password by clicking the blue **Forgot your password** link directly below the Sign in field.
![Forgot-password](1566205596114.png) ![Forgot-password](1566205596114.png)

@ -20,7 +20,7 @@ For further documentation, please visit our [user guide for work packages](./use
## What is a work package? ## What is a work package?
A work package in OpenProject can basically be everything which you need to keep track off within your projects. It can be e.g. a tasks, a feature, a bug, a risk, a milestone or a project phase. This different kinds of work packages are called work package types. A work package in OpenProject can basically be everything you need to keep track off within your projects. It can be e.g. a task, a feature, a bug, a risk, a milestone or a project phase. This different kinds of work packages are called work package types.
## Create a new work package ## Create a new work package

Loading…
Cancel
Save