Merge remote-tracking branch 'origin/release/12.0' into release/12.1

pull/10608/head
Oliver Günther 3 years ago
commit 83d4ae2549
No known key found for this signature in database
GPG Key ID: A3A8BDAD7C0C552C
  1. 7
      docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-trial/README.md
  2. BIN
      docs/enterprise-guide/enterprise-on-premises-guide/enterprise-on-premises-trial/start-trial-with-community-edition.png
  3. 2
      docs/getting-started/projects/README.md
  4. 8
      docs/installation-and-operations/operation/control/README.md
  5. 11
      docs/system-admin-guide/incoming-and-outgoing/webhooks/README.md
  6. BIN
      docs/system-admin-guide/incoming-and-outgoing/webhooks/create-button-new-webhook.png
  7. BIN
      docs/system-admin-guide/incoming-and-outgoing/webhooks/image-20201007133753887.png
  8. BIN
      docs/system-admin-guide/incoming-and-outgoing/webhooks/image-20201007140523324.png
  9. BIN
      docs/system-admin-guide/incoming-and-outgoing/webhooks/incoming-vs-outgoing-webhooks.png
  10. BIN
      docs/system-admin-guide/incoming-and-outgoing/webhooks/steps-to-create-a-webhook.png
  11. 17
      docs/user-guide/activity/README.md
  12. BIN
      docs/user-guide/activity/Work-package-activity-flag-someone.png
  13. BIN
      docs/user-guide/activity/work-package-activity.png
  14. 62
      docs/user-guide/projects/README.md
  15. 2
      docs/user-guide/projects/project-settings/project-information/README.md
  16. 37
      docs/user-guide/projects/project-templates/README.md
  17. BIN
      docs/user-guide/projects/project-templates/image-20210204170739796-0115761.png
  18. BIN
      docs/user-guide/projects/project-templates/image-20210204170739796.png
  19. 2
      docs/user-guide/time-and-costs/progress-tracking/README.md

@ -10,6 +10,12 @@ keywords: Enterprise Edition trial, EOP
You can **test the OpenProject Enterprise on-premises edition 14 days for free**. It will extend your current Community edition with the premium features so you can thoroughly test those premium functionalities.
You can start the trial period for OpenProject either via the Community Edition or via our website.
To upgrade your Community installation, navigate to your system -> Administration -> Enterprise Edition. Here, you can simply click the green **Start free trial button**.
![start trial with community edition](start-trial-with-community-edition.png)
Please go to [our website](https://www.openproject.org/enterprise-edition/) and press the green **Get free trial license** button.
![create-enterprise-edition-trial](1567610649991.png)
@ -29,4 +35,3 @@ You will then **receive the token** with a description how to [activate Enterpri
<div class="alert alert-info" role="alert">
**Note**: The 14 days free Enterprise trial token will run out automatically. There is no need to cancel anything.
</div>

@ -58,7 +58,7 @@ Alternatively, you can use the green **+ button** in the header menu to create a
![create project header](create-project-header.png)
- You can either create a completely new project, create a subproject of an existing project or create a (sub)project from a template. For the latter option, choose a [template](../../user-guide/projects/#create-a-project-template) using the drop-down menu.
- You can either create a completely new project, create a subproject of an existing project or create a (sub)project from a template. For the latter option, choose a [template](../../user-guide/projects/project-templates/#create-a-project-template) using the drop-down menu.
- Enter a **name** for your project and click the blue **Save** button.
- Integrate the project into the existing project hierarchy by defining it as a subproject of an existing project.
- The **Advanced Settings** allow for further configuration, e.g. description, URL, etc.

@ -94,7 +94,7 @@ First, find out the container ID of your web process with:
```bash
# Ensure the containers are running with the following output
docker ps | gre web_1
docker ps | grep web_1
# save the container ID as a env variable $CID
export CID=$(docker ps | grep web_1 | cut -d' ' -f 1)
@ -107,13 +107,13 @@ We can now run commands against that container
Run a bash shell in the container
```bash
docker exec -it $CIT bash
docker exec -it $CID bash
```
Get the current version of OpenProject
```bash
docker exec -it $CIT bash -c "RAILS_ENV=production rails version"
docker exec -it $CID bash -c "RAILS_ENV=production bundle exec rails version"
```
In case of using kubernetes, the command is a bit different
@ -127,7 +127,7 @@ kubectl exec -it {POD_ID} -- bash -c "RAILS_ENV=production bundle exec rails con
Launch an interactive console to directly interact with the underlying Ruby on Rails application:
```bash
docker exec -it $CIT bash -c "RAILS_ENV=production rails console"
docker exec -it $CID bash -c "RAILS_ENV=production bundle exec rails console"
```
## docker-compose based installation

@ -10,13 +10,11 @@ keywords: webhooks
You can set up webhooks for OpenProject in order to integrate OpenProject with other applications. A scenario is for example to signal the creation of a time log in OpenProject to a billing application.
Navigate to -> *Administration* -> *Webhooks* to set up your webhooks in OpenProject.
Navigate to -> *Administration* -> *Incoming vs. Outgoing* -> *Webhooks* to set up your webhooks in OpenProject.
Press the green **+ Webhook** button to add a new webhook to OpenProject.
![image-20201007133753887](image-20201007133753887.png)
![incoming-vs-outgoing-webhooks](incoming-vs-outgoing-webhooks.png)
You can configure the following options for webhooks:
@ -29,6 +27,9 @@ You can configure the following options for webhooks:
7. **Select for which projects the webhook should be active**. You can choose all projects or only specific projects. For example if you select the project "System admin guide", an event (ie. create a new time entry) will be fired via the webhook. This will only happen if a user logs time within the selected projects.
8. Press the blue **Create** button to save your changes.
![steps-to-create-a-webhook](steps-to-create-a-webhook.png)
**Note** You have to scroll down to find the create button. There you can also cancel your input.
![create-button-new-webhook](create-button-new-webhook.png)
![Add new webhook screenshot](image-20201007140523324.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

@ -42,3 +42,20 @@ You can filter for different activities, e.g. for Work packages, News, or Wiki i
The retrospective for the project activities is not limited. You can therefore trace all the project activities back to the beginning of the project.
You can [configure in the admin settings](../../system-admin-guide/) how many days are shown on each activity page. Due to performance reasons, the days displayed should be set at a low level (e.g. 7 days).
### Work package Activity
When you open a work package, e.g. by clicking on the ID of the work package in the work package table, you have the Activity area next to the Work package information area on the right side.
![work package activity](work-package-activity.png)
There, all changes and activities concerning the work package are documented, e.g. if a user changes the status of the work package, this activity is recorded with the information who, when and what in the Activity area and is visible for other users who have the corresponding authorization.
You can also use the Activity area as a chat portal and share messages with other team members there.![Work package activity flag someone](Work-package-activity-flag-someone.png)
If you want to notify a specific user about something in the Activity section, you can also flag them with an "@" symbol in front of their username so that they receive a notification within OpenProject.

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

@ -12,23 +12,23 @@ In OpenProject you can create projects to collaborate with your team members, tr
Your projects can be available publicly or internally. OpenProject does not limit the number of projects, neither in the Community Edition nor in the Enterprise cloud or in Enterprise on-premises edition.
| Topic | Content |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [Select a project](../../getting-started/projects/) | Open a project which you want to work at. |
| Topic | Content |
|------------------------------------------------------------------------------| ------------------------------------------------------------ |
| [Select a project](../../getting-started/projects/) | Open a project which you want to work at. |
| [Create a new project](../../getting-started/projects/#create-a-new-project) | Find out how to create a new project in OpenProject. |
| [Create a subproject](#create-a-subproject) | Create a subproject of an existing project. |
| [Project structure](#project-structure) | Find out how to set up a project structure. |
| [Project settings](#project-settings) | Configure further settings for your projects, such as description, project hierarchy structure, or setting it to public. |
| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent project ("subproject of"). |
| [Set a project to public](#set-a-project-to-public) | Make a project accessible for (at least) all users within your instance. |
| [Create a project template](#create-a-project-template) | Configure a project and set it as template to copy it for future projects. |
| [Use a project template](#use-a-project-template-premium-feature) | Create a new project based on an existing template project. |
| [Copy a project](#copy-a-project) | Copy an existing project. |
| [Archive a project](#archive-a-project) | Find out how to archive completed projects. |
| [Delete a project](#delete-a-project) | How to delete a project? |
| [Global projects overview](#global-projects-overview---view-all-projects) | Get an overview of all your projects in the projects overview list ("View all projects"). |
| [Export project list](#export-projects) | You can export the project list to XLS or CSV. |
| [Project overarching reports](#project-overarching-reports) | How to create project overarching reports across multiple projects? |
| [Create a subproject](#create-a-subproject) | Create a subproject of an existing project. |
| [Project structure](#project-structure) | Find out how to set up a project structure. |
| [Project settings](#project-settings) | Configure further settings for your projects, such as description, project hierarchy structure, or setting it to public. |
| [Change the project hierarchy](#change-the-project-hierarchy) | You can change the hierarchy by selecting the parent project ("subproject of"). |
| [Set a project to public](#set-a-project-to-public) | Make a project accessible for (at least) all users within your instance. |
| [Create a project template](./project-templates/#create-a-project-template) | Configure a project and set it as template to copy it for future projects. |
| [Use a project template](./project-templates/#use-a-project-template) | Create a new project based on an existing template project. |
| [Copy a project](#copy-a-project) | Copy an existing project. |
| [Archive a project](#archive-a-project) | Find out how to archive completed projects. |
| [Delete a project](#delete-a-project) | How to delete a project? |
| [Global projects overview](#global-projects-overview---view-all-projects) | Get an overview of all your projects in the projects overview list ("View all projects"). |
| [Export project list](#export-projects) | You can export the project list to XLS or CSV. |
| [Project overarching reports](#project-overarching-reports) | How to create project overarching reports across multiple projects? |
<video src="https://openproject-docs.s3.eu-central-1.amazonaws.com/videos/OpenProject-Projects-Introduction.mp4" type="video/mp4" controls="" style="width:100%"></video>
@ -125,36 +125,6 @@ Setting a project to public will make it accessible to all people within your Op
(Should your instance be [accessible without authentication](../../system-admin-guide/authentication/authentication-settings) this option will make the project visible to the general public outside your registered users, too)
### Create a project template
You can create a project template in OpenProject by [creating a new project](../../getting-started/projects/#create-a-new-project) and configuring your project to your needs. Name the project so you can identify it as a template, e.g. "Project XY [template]".
Set up everything that you want to have available for future projects.
- Adding project members.
- Selecting the modules.
- Setting up a default project structure in the Gantt chart.
- Creating your work package templates.
- ...
Navigate to the [project settings](project-settings) and click **Set as template** in the upper right corner. You can remove a project from the template collection on the same spot.
<div class="alert alert-info" role="alert">
**Please note**: The option to set a project as template or to remove it from templates is only available for Administrators.
</div>
![set-as-template](image-20210204170739796.png)
### Use a project template (Premium feature)
You can create a new project by using an existing template. This causes the properties of the project template to be copied to the new project. Find out in our Getting started guide how to [create a new project](../../getting-started/projects/#create-a-new-project) in OpenProject.
Another way for using a template project would be to [copy it](#copy-a-project).
<video src="https://openproject-docs.s3.eu-central-1.amazonaws.com/videos/OpenProject-Project-Templates.mp4" type="video/mp4" controls="" style="width:100%"></video>
### Copy a project
You can copy an existing project by navigating to the [project settings](project-settings) and clicking **Copy project** in the upper right of the project settings.

@ -27,7 +27,7 @@ You will have the following options in the project settings.
11. **Create a new subproject** for this project with the green **+ Subproject** button.
12. **Copy the project**. When [copying a project](../../#copy-a-project) you can choose which modules you'd like to copy.
13. **Archive a project**. This way the [archived project](../../#archive-a-project) will not appear in the project selection anymore and cannot be accessed by team members. You can view archived projects in the view all projects list.
14. **Set as template** or **Remove from templates**. By [setting a project as template](../../#create-a-project-template) it can be copied multiple times to create similar projects.
14. **Set as template** or **Remove from templates**. By [setting a project as template](../../project-templates/#create-a-project-template) it can be copied multiple times to create similar projects.
15. **Delete a project**. By [deleting a project](../../#delete-a-project) the whole project with all included information will be removed.
![project-information](image-20201010152113743.png)

@ -0,0 +1,37 @@
---
sidebar_navigation:
title: Project templates
priority: 498
description: How to create project templates.
robots: index, follow
keywords: project templates
---
# Project templates
Project templates can be used for several projects that are similar in structure and members. Creating project templates can save time when creating new projects.
## Create a project template
You can create a project template in OpenProject by [creating a new project](../../../getting-started/projects/#create-a-new-project) and configuring your project to your needs. Name the project so you can identify it as a template, e.g. "Project XY [template]".
Set up everything that you want to have available for future projects.
- Adding project members.
- Selecting the modules.
- Setting up a default project structure in the Gantt chart.
- Creating your work package templates.
Navigate to the [project settings](../project-settings) and click **Set as template** in the upper right corner. You can remove a project from the template collection on the same spot.
<div class="alert alert-info" role="alert">
**Please note**: The option to set a project as template or to remove it from templates is only available for Administrators.
</div>
![set-as-template](image-20210204170739796-0115761.png)
## Use a project template
You can create a new project by using an existing template. This causes the properties of the project template to be copied to the new project. Find out in our Getting started guide how to [create a new project](../../../getting-started/projects/#create-a-new-project) in OpenProject.
Another way for using a template project would be to [copy it](../#copy-a-project).
<video src="https://openproject-docs.s3.eu-central-1.amazonaws.com/videos/OpenProject-Project-Templates.mp4" type="video/mp4" controls="" style="width:100%"></video>

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

@ -17,7 +17,7 @@ OpenProject will automatically roll-up progress to parent work packages.
|-----------------------------------------------------------------------------------------------------|:--------------------------------------------------|
| [Manual progress tracking](#manual-progress-tracking) | How to track progress manually per work package? |
| [Progress tracking in the work package hierarchy](#progress-tracking-in-the-work-package-hierarchy) | How to track progress for multiple work packages? |
| [Status based progress tracking](Status-based-progress-tracking) | How to track progress use work package status? |
| [Status based progress tracking](#status-based-progress-tracking) | How to track progress use work package status? |
## Manual progress tracking

Loading…
Cancel
Save