Merge remote-tracking branch 'origin/documentation' into release/10.3

help/cloud-edition-guide/manage-subscription/README.md

@@ -24,7 +24,7 @@ In the overlay window, you can choose between several topics:
 | Edit Billing Addresses                                       |                                                        |
 | Edit or add payment methods                                  |                                                        |
 | Edit or add payment methods                                  |                                                        |
-| [View billing history and dowload invoices](./invoices-and-billing-history) | How to view the billing history and download invoices? |
+| [View billing history and dowload invoices](../invoices-and-billing-history) | How to view the billing history and download invoices? |
 
 ## Update existing subscriptions
 

help/enterprise-edition-guide/activate-enterprise-edition/README.md

@@ -23,7 +23,7 @@ Next, select **Enterprise Edition** from the menu items (3).
 Do you already have an Enterprise token?
 Yes, then you can proceed entering your token as described below.
 
-No, then you need to [order your Enterprise token](#order-the-enterprise-edition) or [request a trial token](./enterprise-trial) first.
+No, then you need to [order your Enterprise token](#order-the-enterprise-edition) or [request a trial token](../enterprise-trial) first.
 
 In the Enterprise Edition section, copy and paste the full content of your Enterprise support token into the input field and press the blue **Save** button.
 

help/enterprise-edition-guide/enterprise-trial/README.md

@@ -22,7 +22,7 @@ Click the blue **Proceed To Checkout** button.
 
 Enter you email address. Then your details, First name, last name, company name and phone number.
 
-You will then **receive the token with a description how to [activate the Enterprise Edition](./activate-enterprise-edition)** via email.
+You will then **receive the token with a description how to [activate the Enterprise Edition](../activate-enterprise-edition)** via email.
 
 ![enterprise-edition-trial-license](1567610604159.png)
 

help/enterprise-edition-guide/installation-support/README.md

@@ -8,6 +8,6 @@ keywords: installation support
 ---
 # Installation support for the Enterprise Edition
 
-If you want to work with the on premise OpenProject Enterprise Edition but do not have a Community version running, you can order **installation support** during the [booking process of your Enterprise Edition](./activate-enterprise-edition).
+If you want to work with the on premise OpenProject Enterprise Edition but do not have a Community version running, you can order **installation support** during the [booking process of your Enterprise Edition](../activate-enterprise-edition).
 
 The cost for the installation support of a Community version is 150 €. In the price there is no migration included. If you need migration support, please [contact us](mailto:info@openproject.com) for a detailed quotation.

help/system-admin-guide/README.md

@@ -26,15 +26,15 @@ Click on one of the categories in order to proceed with the configuration.
 | [Work packages](./manage-work-packages)            | How to configure work packages, types, status and workflows? |
 | [Custom fields](./custom-fields)                   | Set custom fields for work packages, Spent time, projects, versions, users, groups and more. |
 | [Enumerations](./enumerations)                     | Set enumerations, e.g. work package priorities, time tracking activities, document categories, and more. |
-| [System settings](./sytem-settings)                | Configure your system settings, e.g. a welcome text block on the landing page, display settings, email notifications, incoming emails, repositories, and more. |
+| [System settings](./system-settings)               | Configure your system settings, e.g. a welcome text block on the landing page, display settings, email notifications, incoming emails, repositories, and more. |
 | [Authentication](./authentication)                 | Configure authentication methods in OpenProject, e.g. OAuth, OpenID, Two-factor-authentication, LDAP, and more. |
 | [Announcement](./announcement)                     | How to create a system announcement?                         |
 | [Design](./design)                                 | Create your own design and make it compliant to your company's Corporate Identity, upload logo and customize colors. |
 | [Colors](./colors)                                 | Configure colors used in the system, e.g. status colors, work package types, priorities and more. |
-| [Enterprise Edition](././enterprise-edition-guide) | Upgrade your Community Edition to the Enterprise Edition and enter your valid Enterprise token. |
+| [Enterprise Edition](../enterprise-edition-guide/) | Upgrade your Community Edition to the Enterprise Edition and enter your valid Enterprise token. |
 | [Budgets](./budgets)                               | Configure your currency and create cost types in OpenProject. |
 | [Backlogs](./backlogs)                             | Configure your backlogs settings in OpenProject, e.g. story types to be displayed in the backlogs, task types, and more. |
-| [Billing](././cloud-edition-guide)                 | Manage your OpenProject Cloud Edition, e.g. subscribe to the Cloud Edition, upgrade, downgrade, cancel, and more. |
+| [Billing](../cloud-edition-guide/)                 | Manage your OpenProject Cloud Edition, e.g. subscribe to the Cloud Edition, upgrade, downgrade, cancel, and more. |
 | [Plugins](./plugins)                               | Manage plugins in OpenProject.                               |
 | [Webhooks](./webhooks)                             | Add and manage webhooks in OpenProject.                      |
 | [Information](information)                         | View the latest system information status.                   |

help/system-admin-guide/authentication/ldap-authentication/ldap-group-synchronization/README.md

@@ -13,8 +13,8 @@ Note: This feature is available for the Enterprise Edition only for  OpenProject
 
 In OpenProject EE, you can synchronize LDAP group memberships defined through the [groupOfNames](https://tools.ietf.org/html/rfc4519#section-3.5) LDAP object class. This guide assumes that you:
 
-- - have at least one group defined in OpenProject (See the “[Managing groups](././users-permissions/groups/)” guide for more information on how to create and edit groups),
-  - have set up your LDAP authentication source (See the “[Manage LDAP authentication](./ldap-authentication/)” guide)
+- - have at least one group defined in OpenProject (See the “[Managing groups](../../../users-permissions/groups/)” guide for more information on how to create and edit groups),
+  - have set up your LDAP authentication source (See the “[Manage LDAP authentication](../ldap-authentication/)” guide)
   - have at least one LDAP entry with a *groupOfNames* object class and at least one *member* reference to an entry within your base DN of your LDAP authentication source. We use the inverse *memberOf* filter to determine the members of a group entry.
 
 For the sake of simplicity, we assume that in this guide, your LDAP structure looks like the following:

help/system-admin-guide/manage-work-packages/work-package-settings/README.md

@@ -16,17 +16,17 @@ You can adapt the following under settings:
 
 1. **Allow cross-project work package relations**, i.e. that work packages  created in one project can have relations to work packages in another  project, for example parent-children work packages.
 
-2. **Allow assignment of work packages to groups**. See [here](./users-permissions/groups) how to manage groups.
+2. **Allow assignment of work packages to groups**. See [here](../../users-permissions/groups) how to manage groups.
 
 3. **Display subprojects work packages in main projects** by default. This way the work packages of subprojects will always be visible in the main project if a user has the corresponding role in the subproject to see work packages.
 
 4. **Use current date as start date for new work packages**. This way the current date will always be set as a start date if your create new work packages. Also, if you copy projects, the new work packages will get the current date as start date.
 
-5. **Calculate the work package done ratio with** ... defines how the **Progress %** field is calculated for work packages. If you choose “disable”, the filed will not be shown. If you  select “Use the work package field”, the Progress % field can be manually set in 10% steps  directly in the work package  attribute. If you opt for „Use the work package status“, the Progress % field is chosen based on the status of a work package. In this case a % done value is assigned to every [status](./work-package-status) (for example, “tested” is assigned 80%),  which is then adapted if the status changes.
+5. **Calculate the work package done ratio with** ... defines how the **Progress %** field is calculated for work packages. If you choose “disable”, the filed will not be shown. If you  select “Use the work package field”, the Progress % field can be manually set in 10% steps  directly in the work package  attribute. If you opt for „Use the work package status“, the Progress % field is chosen based on the [status of a work package](../work-package-status). In this case a % done value is assigned to every status (for example, “tested” is assigned 80%),  which is then adapted if the status changes.
 
 6. **Work package export limit**. This setting defines how many work packages you can export at the same time, for example in the the work package lists.
 
-7. **Default highlighting mode** (premium feature) defines which should be the default [attribute highlighting](./././user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-premium-feature) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise and Cloud Edition customers.
+7. **Default highlighting mode** (premium feature) defines which should be the default [attribute highlighting](../../../user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-premium-feature) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise and Cloud Edition customers.
 
    ![default highlighting mode](image-20200116133247958.png)
 

help/system-admin-guide/manage-work-packages/work-package-status/README.md

@@ -41,6 +41,6 @@ A new window will open, where you will be able to specify the following:
 ![Sys-admin-edit-work-package-status](Sys-admin-edit-work-package-status.png)
 
 <div class="alert alert-info" role="alert">
-**Note**: A new status needs to be activated in the [work package workflows](./work-package-workflows) in order to appear in the status drop down of a work package.
+**Note**: A new status needs to be activated in the [work package workflows](../work-package-workflows) in order to appear in the status drop down of a work package.
 </div>
 

help/system-admin-guide/manage-work-packages/work-package-types/README.md

@@ -26,11 +26,11 @@ You will see a list of all work package types in the system.
 Click the green **+ Type** button to add a new work package type in the system, e.g. Risk.
 
 1. Give the new work package type a **name** that easily identifies what kind of work should be tracked.
-2. Choose whether the type should be displayed in the [roadmap](./././user-guide/roadmap/) by default.
-3. Select if the work package type should be **active in new projects by default**. This way work package types will not need to be [activated in the project settings](./././user-guide/project-settings/work-package-types/) but will be available for every project.
-4. Choose a **color** from the drow-down list which should be used for this work package type in the Gantt chart. You can configure new colors [here](./colors).
+2. Choose whether the type should be displayed in the [roadmap](../../../user-guide/roadmap/) by default.
+3. Select if the work package type should be **active in new projects by default**. This way work package types will not need to be [activated in the project settings](../../../user-guide/project-settings/work-package-types/) but will be available for every project.
+4. Choose a **color** from the drow-down list which should be used for this work package type in the Gantt chart. You can configure new colors [here](../../colors).
 5. Choose whether the type should be a **milestone**, e.g. displayed as a milestone in the Gantt chart with the same start and finish date.
-6. You can **copy a [workflow](./work-package-workflows)** from an existing type.
+6. You can **copy a [workflow](../work-package-workflows)** from an existing type.
 7. You can enter a **default text for the work package description field**, which always be shown when creating new work package from this type. This way, you can easily create work package templates, e.g. for risk management or bug tracking which already contain certain required information in the description.
 8. Click the blue **Create** button to add the new type.
 
@@ -45,7 +45,7 @@ To configure a type, first select the type from the list of types (see above) an
 Active attributes shown in blue color on the left will be displayed in the work package form for this type.
 You can then decide for each attribute which group it should be assigned to (using drag and drop or removing it by clicking the remove  icon) *(2)*. You can also rename attribute groups simply by clicking on their name or re-order attribute groups with drag and drop.
 
-Inactive attributes shown in the grey color on the right. Attributes which have been removed are shown in the *Inactive* column on the right *(3)*. This column also includes [custom fields](./custom-fields) which have been created. The custom fields also can be added with drag and drop to the active form (the blue part on the left) to be displayed in the form.
+Inactive attributes shown in the grey color on the right. Attributes which have been removed are shown in the *Inactive* column on the right *(3)*. This column also includes [custom fields](../../custom-fields) which have been created. The custom fields also can be added with drag and drop to the active form (the blue part on the left) to be displayed in the form.
 
 To add additional group, click the **+ Group** button *(4)* and select **Add attribute group**. Give the new group a name. You can then assign attributes (e.g. custom fields) via drag and drop. Note that adding attribute groups is only possible  with the [OpenProject Enterprise Edition](https://www.openproject.org/enterprise-edition/) and the [OpenProject Cloud Edition](https://www.openproject.org/hosting/).
 
@@ -67,7 +67,7 @@ Also, you can add a table of related work packages to your work package form. Cl
 
 ![Sys-admin-table-of-related-work-packages](Sys-admin-table-of-related-work-packages.png)
 
-Now, you can configure which related work packages should be included in your embedded list, e.g. child work packages or work packages related to this work package, and more. Then you can configure how the list should be filtered, grouped, etc. The configuration of the work package list can be done according to the [work package table configuration](./././user-guide/work-packages/work-package-table-configuration/).
+Now, you can configure which related work packages should be included in your embedded list, e.g. child work packages or work packages related to this work package, and more. Then you can configure how the list should be filtered, grouped, etc. The configuration of the work package list can be done according to the [work package table configuration](../../../user-guide/work-packages/work-package-table-configuration/).
 
 Click the blue **Apply** button to add this work package list to your form.
 
@@ -77,11 +77,11 @@ The embedded related work package table in the work package form will look like
 
 ![Sys-admin-related-work-package-table](Sys-admin-related-work-package-table.png)
 
-## Activate projects for work package types
+## Activate work package types for projects
 
 Under -> *Administration* -> *Work packages* -> *Types* on the tab **Projects** you can select for which projects this work package type should be activated. 
 
-The Activated for new projects by default setting in the Types will only activate this type for new projects. For existing projects, the type needs to be activated manually. 
-This can be also configured in the [project settings](././user-guide/project-settings).
+The **Activated for new projects by default** setting in the Types will only activate this type for new projects. For existing projects, the type needs to be activated manually. 
+This can be also configured in the [project settings](../../../user-guide/project-settings).
 
 ![activate projects for work package types](image-20200116150513323.png)

help/system-admin-guide/manage-work-packages/work-package-workflows/README.md

@@ -12,7 +12,7 @@ keywords: work package workflows
 
 A **workflow** in OpenProject is defined as the allowed transitions between status for a role and a type, i.e. which status changes can a certain role implement depending on the work package type.
 
-This means, a certain type of work package, e.g. a Task, can have the following workflows: News -> In Progress -> Closed -> On Hold -> Rejected -> Closed. This workflow can be different depending on the [role in a project](././users-permissions/roles-permissions).
+This means, a certain type of work package, e.g. a Task, can have the following workflows: News -> In Progress -> Closed -> On Hold -> Rejected -> Closed. This workflow can be different depending on the [role in a project](../../users-permissions/roles-permissions).
 
 ## Edit workflows
 
@@ -22,7 +22,7 @@ To edit a workflow:
 2. Select the **work package type** from the dropdown menu for which you want to edit the workflow.
 3. Check if you **only want the statuses that are used by this type** to be displayed (this option is selected automatically, but you can always uncheck it). 
 <div>
-**Note**: If you have created a [new status](./work-package-status) and want to add it to a workflow of a certain work package type, you need to deselect this option. Only this way also status that are not (yet) used by this type will appear in the list and can be added to a workflow.
+**Note**: If you have created a [new status](../work-package-status) and want to add it to a workflow of a certain work package type, you need to deselect this option. Only this way also status that are not (yet) used by this type will appear in the list and can be added to a workflow.
 </div>
 
 4. Click the **Edit** button.

help/system-admin-guide/system-settings/README.md

@@ -14,12 +14,12 @@ There are various project overarching settings that are referred to as **system
 
 ## Overview
 
-| Popular Topics                                 | Description                                                  |
-| ---------------------------------------------- | :----------------------------------------------------------- |
-| [General settings](/general-settings)          | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
-| [Display settings](/display-settings)          | How to configure languages, date and time formats, week start, and more? |
-| [System projects settings](/projects-settings) | How to set default project modules and more?                 |
-| [Email notifications](/email-notifications)    | How to configure email notifications and your email provider? |
-| [Incoming emails](/incoming-emails)            | How to set up incoming emails?                               |
-| [Repositories](/repositories)                  | How to integrate SVN or GIT repositories?                    |
+| Popular Topics                                       | Description                                                  |
+| ---------------------------------------------------- | :----------------------------------------------------------- |
+| [General settings](/general-settings)                | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
+| [Display settings](/display-settings)                | How to configure languages, date and time formats, week start, and more? |
+| [System projects settings](/project-system-settings) | How to set default project modules and more?                 |
+| [Email notifications](/email-notifications)          | How to configure email notifications and your email provider? |
+| [Incoming emails](/incoming-emails)                  | How to set up incoming emails?                               |
+| [Repositories](/repositories)                        | How to integrate SVN or GIT repositories?                    |
 

help/system-admin-guide/system-settings/display-settings/README.md

@@ -0,0 +1,34 @@
+---
+sidebar_navigation:
+  title: Language and display settings
+  priority: 900
+description: Display settings in OpenProject.
+robots: index, follow
+keywords: display settings
+---
+# Language and display settings
+
+You can configure display settings in OpenProject. Under System settings on the tab **Display** you can configure the following options.
+
+## Configure available languages
+
+Choose the languages which you want to activate for your system. Those languages which you will check will appear in the language settings of the user profiles and can be set for the system.
+
+![available languages](image-20200123100856639.png)
+
+At the moment there are more than 30 languages available.
+**Note**: Many languages are translated by the Community. We highly appreciate if you want to [help translating OpenProject to your language](../development/translate-openproject).
+</div>
+
+## Time and date formatting
+
+Change time and date formats in OpenProject and configure the display of journal aggregation.
+
+1. Configure when the **week starts** (e.g. in the calendar view). Default is based on user's language. You can also choose to start a week always on Monday, Sunday or Saturdays.
+2. Set the **date format**, default is based on user's language. You can choose various formats to display dates in the system.
+3. Set the **time format**, default is based on user's language. You can choose various formats to display time in the system.
+4. Choose the **users display format**, default is Firstname Lastname. You can change to various different formats.
+5. **Display journals as aggregated within** will enable you to choose a time to combine journals of this timespan, e.g. for work package notifications. This way if you do several updates at in a short period of time, you will not receive a notification for each update but only a notification for the chosen period.
+6. Do not forget to **save** your changes.
+
+![Sys-admin-display-settings](Sys-admin-display-settings.png)

help/system-admin-guide/system-settings/email-notifications/README.md

@@ -0,0 +1,12 @@
+---
+sidebar_navigation:
+  title: Email notifications
+  priority: 700
+description: Email notifications in OpenProject.
+robots: index, follow
+keywords: email notifications
+---
+# Project system settings
+
+To adapt email notification settings, go to System settings on the tab **Email notifications** you can configure the following options.
+

help/system-admin-guide/system-settings/general-settings/README.md

@@ -42,7 +42,7 @@ You can configure general system settings in OpenProject. Under System settings
 
 ## Welcome block text
 
-Create a welcome text block to display to users on your [application start page](../user-guide/start-page).
+Create a welcome text block to display the most important information to users on your [application start page](../user-guide/start-page).
 
 1. Insert a **welcome block title**.
 2. Add the **welcome block text description**. You can add the same formatting options, as well as macros (work package lists etc.) as for the general text blocks.

help/system-admin-guide/system-settings/project-system-settings/README.md

@@ -0,0 +1,19 @@
+---
+sidebar_navigation:
+  title: Project system settings
+  priority: 800
+description: Project system settings in OpenProject.
+robots: index, follow
+keywords: project system settings
+---
+# Project system settings
+
+To adapt system project settings, go to System settings on the tab **Projects** you can configure the following options.
+
+1. Check if **new projects are public by default**. This means that users without an account can access the project without login.
+2. Select **which modules should be activated for newly created projects per default**.
+3. Choose whether **sequential project identifiers should be created**. If this option is activated, a project identifier for the next project will be offered automatically, based on the existing project name. For example, if a project “Myproject1” was created, “Myproject2” will be offered as identifier for the next project.
+4. The r**ole given to a user in a new project when the user created a new project but is not an admin**. This makes sense when a user receives the permission to create a new project via [global role](./users-permissions/roles-permissions/).
+5. Do not forget to **save** your changes.
+
+![Sys-admin-project-system-settings](Sys-admin-project-system-settings.png)

help/system-admin-guide/users-permissions/avatars/README.md

@@ -12,7 +12,7 @@ To select which type of Avatars can be used in your OpenProject, navigate to ->
 
 You can choose whether to allow user Gravatar or enable to upload custom avatars.
 
-The Avatars can be configured via the [users profile](./users).
+The Avatars can be configured via the [user profile](../users).
 
 ![Avatars](image-20200115173409850.png)
 

help/system-admin-guide/users-permissions/roles-permissions/README.md

@@ -12,7 +12,7 @@ A role is a set of permissions that can be assigned to any project  member. Mult
 
 In contrast to “normal” project roles, **Global roles** are project-overarching roles that can be assigend to a user and allow certain actions (for example, creating new projects).
 
-Global roles can be added to a [user profile](././users/#view-user-profile).
+Global roles can be added to a [user profile](../users/#view-user-profile).
 
 ## Create a new role
 

help/system-admin-guide/users-permissions/users/README.md

@@ -35,7 +35,7 @@ Also, you get the information when the user has been created, and when the user
 
 If you want to **block users permanently** in the system, you can click the **Lock permanently** link next to a user.
 
-If you are using the [OpenProject Cloud Edition](../cloud-edition-guide), you will then have a new user available to add to the system within your booked plan.
+If you are using the [OpenProject Cloud Edition](../../cloud-edition-guide), you will then have a new user available to add to the system within your booked plan.
 
 <div class="alert alert-info" role="alert">
 **Note**: The previous activities from this locked users will still be displayed in the system.
@@ -90,13 +90,13 @@ You will see all the Activities accross all projects from this user, as well as
 
 ### General settings
 
-You can manage individual user settings if you click on the user name in the list. The settings will overwrite the individual user settings set in the [My Account settings](../getting-started/my-account/).
+You can manage individual user settings if you click on the user name in the list. The settings will overwrite the individual user settings set in the [My Account settings](../../../getting-started/my-account/).
 
 (1) Change username, first name, last name, email address or language. Activate or deactivate **Administrator** permission.
 
 (2) See user based custom fields.
 
-(3) Display last given [user consent](././settings/#user-consent).
+(3) Display last given [user consent](../settings/#user-consent).
 
 (4) Display **authentication provider**.
 
@@ -118,7 +118,7 @@ On the **Projects** tab, select the new project from the drop-down list, choose
 
 ### Add users to groups
 
-In order to add a user to a group, at least [one group needs to be created](././groups) in the system.
+In order to add a user to a group, at least [one group needs to be created](../groups) in the system.
 
 Select or de-select the groups a user should be a member of. Click the blue **Save** button.