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

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/getting-started/my-account/README.md

@@ -15,7 +15,7 @@ Change your personal settings in My Account. Here you can adapt, e.g. the langua
 | [Change password](#change-password)                          | How to change my password?                                   |
 | [Edit your user information](#edit-your-user-information)    | How to change the name or email address 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-premium-feature) | How to set up a two-factor authentication?                   |
 | [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 and change the profile picture? |
 | [Delete account](#delete-account)                            | How to delete my own account?                                |

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

@@ -8,19 +8,19 @@ keywords: announcement
 ---
 # Announcement
 
-Coming soon!
+You can configure **announcements in OpenProject** which will be displayed for a certain period of time for users when the login.
 
-## Overview
+1. Enter a **text** for your announcement message.
+2. **Define a date until when the announcement should be shown**.
+3. **Set the announcement to active**. Only then will the announcement be shown.
+4. **Save** your changes.
 
-| Popular Topics | Description |
+![Sys-admin-announcement](Sys-admin-announcement-1579796618282.png)
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
 
+The active announcement will be displayed until the defined date to users **on the login screen**.
+
+![Sys-admin-downtime-announcement](Sys-admin-downtime-announcement.png)
+
+Also, the active announcement will be displayed until the defined date to users **on the application start page**.
+
+![Sys-admin-announcement-start-page](Sys-admin-announcement-start-page.png)

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

@@ -8,19 +8,19 @@ keywords: authentication
 ---
 # Authentication
 
-Coming soon!
+Configure **authentication** settings and authentication providers in OpenProject.  To adapt these authentication settings, navigate to your user name and select -> *Administration* -> *Authentication*.
+
+![Sys-admin-authentication](Sys-admin-authentication-1579787715984.png)
 
 ## Overview
 
 | Popular Topics                                               | Description                                                  |
-| -------------- | :---------- |
+| ------------------------------------------------------------ | :----------------------------------------------------------- |
-|                |             |
+| [Authentication settings](authentication-settings)           | Configure general authentication settings, such as registration, passwords, and more. |
-|                |             |
+| [OAuth applications](oauth-applications)                     | How to configure OAuth applications in OpenProject?          |
-|                |             |
+| [OpenID providers](openid-providers)                         | How to configure OpenID providers in OpenProject?            |
-|                |             |
+| [Two-factor authentication](two-factor-authentication)       | Set up and manage two-factor authentication (2FA) in OpenProject. |
-|                |             |
+| [reCAPTCHA](recaptcha)                                       | How to activate reCAPTCHA in OpenProject?                    |
-|                |             |
+| [LDAP authentication](ldap-authentication)                   | How to set up LDAP authentication in OpenProject?            |
-|                |             |
+| [LDAP group synchronization](ldap-authentication/ldap-group-synchronization) | How to configure LDAP group synchronization in OpenProject (Premium feature)? |
-|                |             |
-|                |             |
 

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

@@ -0,0 +1,67 @@
+---
+sidebar_navigation:
+  title: Settings
+  priority: 990
+description: Authentication settings in OpenProject.
+robots: index, follow
+keywords: authentication settings
+---
+# Authentication settings
+
+To adapt general system **authentication settings**, navigate to -> *Administration* -> *Authentication* and choose -> *Settings*.
+
+You can adapt the following under the authentication settings:
+
+## General authentication settings
+
+1. Select if the **authentication is required** to access OpenProject.
+
+2. Select an option for **self-registration**. Self-registration can either be **disabled**, or it can be allowed with the following criteria:
+
+   a) **Account activation by email** means the user receives an email and needs to confirm the activation.
+
+   b) **Manual account activatio**n means that a system administrator needs to manually activate the newly registered user.
+
+   c) **Automatic account activation** means that a newly registered user will automatically be active.
+
+3. Define if the **email address should be used as login** name.
+
+4. Define after how many days the **activation email sent to new users will expire**. Afterwards, you will have the possibility to [re-send the activation email](../../users-permissions/users/#resend-user-invitation-via-email) via the user settings.
+
+![Sys-admin-authentication-settings](Sys-admin-authentication-settings.png)
+
+## Define a registration footer for registration emails
+
+You can define a footer for your registration emails under -> *Administration* -> *Authentication* -> *Settings*.
+
+1. Choose for which **language** you want to define the registration footer.
+2. Enter a **text for the registration footer**.
+
+![Sys-admin-authentication-registration-footer](Sys-admin-authentication-registration-footer.png)
+
+## Configure password settings
+
+You can change various settings to configure password preferences in OpenProject.
+
+1. Define the **minimum password length**.
+2. Define the password strength and select what **character classes are a mandatory part of the password**.
+3. Define the **minimum number of required character classes**.
+4. Define the number of days, after which a **password change should be enforced**.
+5. Define the **number of the most recently used passwords that a user should not be allowed to reuse**.
+6. Activate the **Forgot your password.** This way a user will be able to reset the own password via email.
+
+![Sys-admin-authentication-passwords](Sys-admin-authentication-passwords-1579791010597.png)
+
+## Other authentication settings
+
+There can be defined a number of other authentication settings.
+
+1. Define the number of failed **login attempts, after which a user will be temporarily blocked**.
+2. Define the **duration of the time, for which the user will be blocked after failed login attempts**.
+3. Enable or disable the **autologin option**. This allows a user to remain logged in, even if he/she leaves the site. If this option is activated, the “Stay signed in” option will appear on the login screen to be selected.
+4. Activate the **session expiration option**. If you select this option, an additional field will open, where you will be able to define the **inactivity time duration before the session expiry**.
+5. Define to **log user login, name, and mail address for all requests**.
+6. **Enable REST web service**. This activates an API-Interface, which allows communication between external services (for example MS Office)  and the instance.
+7. Do not forget to **save** your changes.
+
+![Sys-admin-authentication-other-settings](Sys-admin-authentication-other-settings.png)

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

@@ -14,7 +14,7 @@ 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 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/authentication/oauth-applications/README.md

@@ -0,0 +1,29 @@
+---
+sidebar_navigation:
+  title: OAuth applications
+  priority: 900
+description: OAuth application settings in OpenProject.
+robots: index, follow
+keywords: OAuth application settings
+---
+# OAuth applications
+
+To activate and configure oauth applications, navigate to -> *Administration* -> *Authentication* and choose -> *Oauth applications*.
+
+## Add a new authentication application for oauth
+
+To add a new oauth application, click the green **+ Add** button.
+
+![Sys-admin-authenticatoin-oauth-applications](Sys-admin-authenticatoin-oauth-applications.png)
+
+
+
+You can configure the following options to add your oauth application.
+
+1. Enter the **name** of your oauth application.
+2. **Define redirect URLs** where authorized users can be redirected to.
+3. Check if the application will be used **confidentially**.
+4. Choose **client credential flows** and define a user on whose behalf requests will be performed.
+5. Press the blue **Create** button to add your oauth application.
+
+![Sys-admin-authentication-add-oauth-application](Sys-admin-authentication-add-oauth-application.png)

help/system-admin-guide/authentication/openid-providers/README.md

@@ -0,0 +1,31 @@
+---
+sidebar_navigation:
+  title: OpenID providers
+  priority: 800
+description: OpenID providers for OpenProject.
+robots: index, follow
+keywords: OpenID providers
+---
+# OpenID providers
+
+<div class="alert alert-info" role="alert">
+**Note**: For the OpenID configuration view our docs in Github:  https://github.com/opf/openproject/blob/dev/docs/configuration/openid.md  (Todo: needs to be moved to documentation).
+</div>
+
+To activate and configure OpenID providers in OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *OpenID providers*.
+
+## Add a new authentication application for oauth
+
+To add a new OpenID provider, click the green **+ OpenID provider** button.
+
+![Sys-admin-authentication-openid-provider](Sys-admin-authentication-openid-provider.png)
+
+You can configure the following options.
+
+1. Choose **Google** or **Azure** to add as an OpenID provider to OpenProject.
+2. Optionally enter a **display name**.
+3. Enter the **Identifier**.
+4. Enter the **Secret**.
+5. Press the blue **create** button.
+
+![Sys-admin-authentication-add-openid-provider](Sys-admin-authentication-add-openid-provider.png)

help/system-admin-guide/authentication/recaptcha/README.md

@@ -0,0 +1,22 @@
+---
+sidebar_navigation:
+  title: reCAPTCHA
+  priority: 600
+description: configure reCAPTCHA for OpenProject.
+robots: index, follow
+keywords: reCAPTCHA
+---
+# reCAPTCHA configuration
+
+To activate and **configure reCAPTCHA** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> reCAPTCHA.
+
+ If enabled, a captcha form will be rendered upon login for all users that have not verified a captcha yet. Please see the following link for more details on reCAPTCHA and their versions, and how to create the website and secret keys: https://www.google.com/recaptcha.
+
+You can configure the following options:
+
+1. Activate reCAPTCHA for OpenProject. You can choose between reCAPTCHA v2 and reCAPTCHA v3.
+2. Insert the **website key**.
+3. Insert the **secret key**.
+4. Press the blue **Apply** button to save your changes.
+
+![Sys-admin-authentication-recaptcha](Sys-admin-authentication-recaptcha.png)

help/system-admin-guide/authentication/two-factor-authentication/README.md

@@ -0,0 +1,19 @@
+---
+sidebar_navigation:
+  title: Two-factor authentication
+  priority: 700
+description: configure two-factor authentication for OpenProject.
+robots: index, follow
+keywords: two-factor authentication
+---
+# Two-factor authentication (Premium feature)
+
+To activate and **configure two-factor authentication** for OpenProject, navigate to -> *Administration* -> *Authentication* and choose -> *two-factor authentication*.
+
+You can configure the following options:
+
+1. **Enforce two-factor authentication (2FA) for the whole system**. All users will be forced to [register a 2FA device](../../../getting-started/my-account/#two-factor-authentication-premium-feature) on their next login.
+2. **Remember 2FA login for a given number of days**, e.g. 30 days.
+3. Press the blue **Apply** button to save your changes.
+
+![Sys-admin-authentication-two-factor-authentication](Sys-admin-authentication-two-factor-authentication.png)

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

@@ -1,6 +1,6 @@
 ---
 sidebar_navigation:
-  title: Budget
+  title: Budgets
   priority: 680
 description: Define budgets in OpenProject.
 robots: index, follow
@@ -8,19 +8,16 @@ keywords: budgets
 ---
 # Budgets
 
-Coming soon!
+You can configure costs in OpenProject and can create cost types.
 
-## Overview
+Navigate to -> *Administration* -> *Budgets*.
 
-| Popular Topics | Description |
+## Settings
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
 
+Define settings for OpenProject costs.
+
+1. Configure the **currency used in the system, e.g. EUR**.
+2. **Specify the format of the currency**, if the number should be before or after the currency, e.g. 10 EUR, or $ 10.
+3. Press the blue **Apply** button to save your changes.
+
+![Sys-admin-configure-costs](Sys-admin-configure-costs.png)

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

@@ -8,19 +8,18 @@ keywords: colors
 ---
 # Colors
 
-Coming soon!
+To define a set of colors in OpenProject, navigate to -> *Administration* -> *Colors*. 
 
-## Overview
+You can configure a set of predefined colors in OpenProject which you can choose for e.g. [set colors for work package types](../manage-work-packages/work-package-types/) or attribute highlighting, e.g. for [status](../manage-work-packages/work-package-status/).
 
-| Popular Topics | Description |
+## Define a new color in OpenProject
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
 
+To add a new color, press the green **+ Color** button at the top right.
+
+![Sys-admin-colors](Sys-admin-colors.png)
+
+1. Add a **name** for your new color.
+2. Enter the **hexcode** for your new color.
+3. Press the blue **Save** button.
+
+![Sys-admin-new-color](Sys-admin-new-color.png)

help/system-admin-guide/custom-fields/README.md

@@ -33,7 +33,7 @@ Depending on the module, for which the new custom field is being  created, sligh
 4. **Regular expression** specifying which values are allowed for the custom field.
 5. Set if the new custom field should be a **required** field.
 6. Specify if the new custom field should be **used for all projects**. This means the custom field will be active for all projects and does not need to be activated separately per project.
-7. Specify if the new custom field should be **used as a filter for work packages**. See [here](../user-guide/work-packages/work-package-table-configuration/#filter-work-packages) how to filter work packages.
+7. Specify if the new custom field should be **used as a filter for work packages**. See [here](../../user-guide/work-packages/work-package-table-configuration/#filter-work-packages) how to filter work packages.
 8. Specify if the new custom field should be **searchable** via the global search.
 9. **Save** the new custom field.
 
@@ -47,11 +47,11 @@ Depending on the module, for which the new custom field is being  created, sligh
     2. Custom field is activated for the project.
 </div>
 
-1. [Assign a custom field to a work package type](./manage-work-packages/work-package-types/#work-package-form-configuration) (Form configuration). You can do this directly via the link in the custom field overview.
+1. [Assign a custom field to a work package type](../manage-work-packages/work-package-types/#work-package-form-configuration) (Form configuration). You can do this directly via the link in the custom field overview.
 
 ![Sys-admin-add-custom-field](Sys-admin-add-custom-field.png)
 
-2. Activate the custom field in a project [through the project settings](../user-guide/project-settings/custom-fields/). This is not relevant if the setting **For all projects** has been configured for the custom field.
+2. Activate the custom field for a project in the [project settings](../../user-guide/project-settings/custom-fields/). This is not relevant if the setting **For all projects** has been configured for the custom field.
 
 With these additional settings, you have absolute freedom which  custom fields are relevant for your projects and types. You can customize only those types that are relevant and create a whole set of  custom attributes for your work packages.
 

help/system-admin-guide/custom-fields/custom-fields-projects/README.md

@@ -21,7 +21,7 @@ Click on the link **Create a new custom field** to create a project custom field
 2. Choose a **format** (e.g. List) for the custom field, e.g. list.
 3. **Enter the possible values** which can be selected (for a list). This is not relevant if you choose e.g. Text format.
 4. Define if the custom field should be **required**.
-5. If you check **visible** it will also be visible for all users (non Admins) in the project overview and displayed in the project details widget on the [Project Overview](../user-guide/project-overview/).
+5. If you check **visible** it will also be visible for all users (non Admins) in the project overview and displayed in the project details widget on the [Project Overview](../../../user-guide/project-overview/).
 6. Define if the custom field for projects should be **searchable**.
 7. Click **Save** to create the custom field.
 
@@ -29,7 +29,7 @@ Click on the link **Create a new custom field** to create a project custom field
 
 ## Setting and displaying a project custom field
 
-Once you created the custom field you can set it in the [project’s settings](../user-guide/project-settings/).
+Once you created the custom field you can set it in the [project settings](../../../user-guide/project-settings/).
 
 To do this navigate to a project and select *Project settings* from the side menu. The project custom field is visible under *Information*. As a project manager you can set the project custom field.
 

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

@@ -15,11 +15,11 @@ 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? |
+| [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? |
+| [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?                 |
+| [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? |
+| [Email notifications](email-notifications)          | How to configure email notifications and your email provider? |
-| [Incoming emails](/incoming-emails)                  | How to set up incoming emails?                               |
+| [Incoming emails](incoming-emails)                  | How to set up incoming emails?                               |
-| [Repositories](/repositories)                        | How to integrate SVN or GIT repositories?                    |
+| [Repositories](repositories)                        | How to integrate SVN or GIT repositories?                    |
 

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

@@ -17,7 +17,8 @@ Choose the languages which you want to activate for your system. Those languages
 ![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>
+**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

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

@@ -6,7 +6,23 @@ description: Email notifications in OpenProject.
 robots: index, follow
 keywords: email notifications
 ---
-# Project system settings
+# Email notifications settings
 
 To adapt email notification settings, go to System settings on the tab **Email notifications** you can configure the following options.
 
+1. **Emission email address**. This email Address will be shown as the sender for the email notifications sent by OpenProject (for example,  when a work package is changed).
+2. Activate **blind carbon copy recipients** (bcc).
+3. Define if the email should be formatted in **plain text** (no HTML).
+4. Select the default notification options. The default notifcation can be adapted in the [user profile](../../../getting-started/my-account/#email-notifications).
+5. Select for which **actions email notification should be sent**. You have the possibilty to check all or uncheck all at the top right.
+
+![Sys-admin-system-settings-email-notification](Sys-admin-system-settings-email-notification.png)
+
+## Configure email header and email footer
+
+Configure your notification email header and footer which will be sent out for email notifications from the system.
+
+1. **Formulate header and/or footer** for the email notifications. These are used for all the email notifications from OpenProject (e.g. when  creating a work package).
+2. **Choose a language** for which the email header and footer will apply.
+3. **Send a test email**.
+4. Do not forget to **save** your changes.![Sys-admin-email-notifications-email-header-footer](Sys-admin-email-notifications-email-header-footer.png)

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

@@ -10,13 +10,13 @@ keywords: general settings
 
 You can configure general system settings in OpenProject. Under System settings on the tab **General** you can configure the following options.
 
-1. **Application title**: This title will be displayed on the [application start page](../user-guide/start-page).
+1. **Application title**: This title will be displayed on the [application start page](../../../user-guide/start-page).
 
 2. **Attachment maximum size** defines the maximum size of an attachment (for example in a work package).
 
 3. **Object per page options** define the options of how many objects  (for example work packages or news entries) you can have displayed on one page. This is used for the pagination in the work package list. You can enter several values, separated by coma. Please note that the higher value you set, the more work packages will be initially loaded and therefore it might take longer time to load a work package page.
 
-4. **Days displayed on project activity** determines how far back the project activities will be traced and displayed in the project's [Activity](../user-guide/activity).
+4. **Days displayed on project activity** determines how far back the project activities will be traced and displayed in the project's [Activity](../../../user-guide/activity).
 
 5. **Host name**.
 
@@ -34,7 +34,7 @@ You can configure general system settings in OpenProject. Under System settings
 
 12. **Max number of diff lines displayed** defines the maximum number of lines displayed when comparing (diff) two versions in a repository.
 
-13. **Display security badge** enables to display a badge with your installation status in the [Information administration panel](./information), and on the [start page](../user-guide/start-page). It is displayed to administrators only.
+13. **Display security badge** enables to display a badge with your installation status in the [Information administration panel](../../information), and on the [start page](../user-guide/start-page). It is displayed to administrators only.
 
     The badge will check your current OpenProject version against the official OpenProject release database to alert you of any updates or  known vulnerabilities. For more information on what the check provides,  what data is needed to provide available updates, and how to disable this check, please visit [the configuration documentation](https://github.com/opf/openproject/blob/dev/docs/configuration/configuration.md#security-badge).        
 

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

@@ -0,0 +1,20 @@
+---
+sidebar_navigation:
+  title: Incoming emails
+  priority: 600
+description: Configure incoming email in OpenProject.
+robots: index, follow
+keywords: incoming email
+---
+# Incoming emails settings
+
+To adapt incoming email settings, go to System settings on the tab **Incoming emails** you can configure the following options.
+
+1. **Define after which lines an email should be truncated**. This setting allows shortening email after the entered lines.
+2. Specify a **regular expression** to truncate emails.
+3. **Ignore mail attachment** of the specified names in this list.
+4. Do not forget to **save** the changes.
+
+![Sys-admin-system-setting-incoming-emails](Sys-admin-system-setting-incoming-emails.png)
+
+**To set up incoming email**, please visit our [Operations guide](../../../installation-and-operations/operation/#). (To Do: Migrate incoming email guide from: https://www.openproject.org/operations/configuration/incoming-emails/)

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

@@ -13,7 +13,7 @@ To adapt system project settings, go to System settings on the tab **Projects**
 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/).
+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/system-settings/repositories/README.md

@@ -0,0 +1,49 @@
+---
+sidebar_navigation:
+  title: Repositories settings
+  priority: 500
+description: Repositories settings in OpenProject.
+robots: index, follow
+keywords: repository settings
+---
+# Repositories settings
+
+To adapt repositories settings, go to System settings on the tab **Repositories** you can configure the following options.
+
+1. **Autofetch repository changes**. This option allows to automatically show commits in an OpenProject Repository.
+2. **Repository disk size cache**. In order to cache the repository disk size (displayed e.g. in repository page).
+3. **Enable repository management web service**. This option allows communication with SVN- or Git-Clients. If it is deactivated, a repository cannot be created.
+4. **Define an API key**. This API key is created once and used for communication with an SVN or Git client.
+5. Select which **SCM** you want to enabled. You can choose **Git** and/or **Subversion**.
+6. **Automatic repository vendor type**. Specify the default repository type which is used in new projects.
+7. **Define repositories encodings**.
+8. Define the **maximum number of revisions to be displayed on file log**.
+9. Define the **maximum number of files displayed in the repository browser**.
+10. **Enable caching for authentication request of version control software**. This option allows saving the authentication so that a user doesn’t have to authenticate every time a repository is accessed (for  example during commits).
+
+1. ![Sys-admin-system-settings-repositories](Sys-admin-system-settings-repositories.png)
+
+
+
+## Checkout instructions for Subversion and GIT
+
+Show checkout instructions for Subversion and GIT.
+
+1. Select whether or not to **display checkout instructions** on the repository page.
+2. **Checkout base URL**. Define the base URL to be used for repositories of new projects.
+3. **Checkout instruction text**. Used to specify an (optional) instruction text for repositories (can be further specified in project settings).
+
+![Sys-admin-system-settings-repositories-checkout-instructions](Sys-admin-system-settings-repositories-checkout-instructions.png)
+
+## Referencing and fixing work packages in commit messages
+
+1. **Define referencing keywords** for work packages in commit messages.  Used to reference keywords used to link revisions to work packages.
+2. Define **fixing keywords for work packages** in commit messages. Fixing keywords allow status or progress changes using certain keywords in commit messages, e.g. changing a work pacakge to closed and set to 100%.
+3. Define which **status will be applied** to a work package if a fixing word is used in a commit message.
+4. Define which **percentage of done is applied** to a work package if a fixing word is used in a commit message for that work package.
+5. **Enable time logging**. Activating this option enables [logging time to a work package ](../../../user-guide/time-and-costs/time-tracking/)via commit message.
+6. Define **activity for logged time**. This activity is used for time logging via a commit.
+
+![Sys-admin-system-settings-repositories-fixing-commit-messages](Sys-admin-system-settings-repositories-fixing-commit-messages.png)
+
+7. Do not forger to **Save** all your changes.

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.

help/user-guide/project-overview/README.md

@@ -95,7 +95,7 @@ The description can be added or changed in the [project settings](../projects/).
 
 The project details widget displays all custom fields for projects, e.g. project owner, project due date, project number, or any other custom field for this project.
 
-The custom fields can be adapted in the [project settings](./project-settings/). As a system administrator you can [create new custom fields for projects](../system-admin-guide/custom-fields/projects-custom-fields/).
+The custom fields can be adapted in the [project settings](../project-settings/). As a system administrator you can [create new custom fields for projects](../../system-admin-guide/custom-fields/custom-fields-projects/).
 
 ![project details widget](image-20191112144557906.png)
 

help/user-guide/project-settings/custom-fields/README.md

@@ -0,0 +1,24 @@
+---
+sidebar_navigation:
+  title: Custom fields
+  priority: 
+description: Manage custom fields in a project.
+robots: index, follow
+keywords: custom fields
+---
+# Manage custom fields in projects
+
+Coming soon!
+
+| Feature | Documentation for |
+| ------- | ----------------- |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+|         |                   |
+