Merge branch 'release/10.3' into dev

2026-06-13 19:20:00 +00:00 · 2020-01-28 13:47:48 +01:00
parent 9b17386cd9 9b01830c24
commit 7efa45563c
69 changed files with 478 additions and 225 deletions
@@ -48,14 +48,7 @@ if defined?(Unicorn) && Rails.env.production?
  use Unicorn::WorkerKiller::MaxRequests, min_req, max_req
 end

-##
-# Returns true if the application should be run under a subdirectory.
-def map_subdir?
-  # Don't map subdir when using Passenger as passenger takes care of that.
-  !defined?(::PhusionPassenger)
-end
-
-subdir = map_subdir? && OpenProject::Configuration.rails_relative_url_root.presence
+subdir = OpenProject::Configuration.rails_relative_url_root.presence

 map (subdir || '/') do
  use Rack::Protection::JsonCsrf
@@ -3,6 +3,8 @@ set -e

 pushd "${APP_PATH}/frontend"

+export NG_CLI_ANALYTICS=ci # so angular cli doesn't block waiting for user input
+
 # Installing frontend dependencies
 RAILS_ENV=production npm install

@@ -68,9 +68,8 @@ migrate() {
 	wait_for_postgres
 	pushd $APP_PATH >/dev/null
 	/etc/init.d/memcached start
-	bundle exec rake db:migrate db:seed db:structure:dump
+	bundle exec rake db:migrate db:seed
 	/etc/init.d/memcached stop
-	chown "$APP_USER.$APP_USER" db/structure.sql
 	popd >/dev/null
 }

@@ -111,5 +110,13 @@ fi
 echo "-----> Database setup finished."
 echo "       On first installation, the default admin credentials are login: admin, password: admin"

+if [ -n "$OPENPROJECT_RAILS__RELATIVE__URL__ROOT" ]; then
+	echo
+	echo "-----> Precompiling assets since RAILS_RELATIVE_URL_ROOT is set. This may take a minute."
+	RAILS_RELATIVE_URL_ROOT=$OPENPROJECT_RAILS__RELATIVE__URL__ROOT bash /app/docker/precompile-assets.sh
+	echo "-----> Asset precompilation finished."
+	echo
+fi
+
 echo "-----> Launching supervisord..."
 exec /usr/bin/supervisord -c $APP_PATH/docker/supervisord.conf -e ${SUPERVISORD_LOG_LEVEL}
@@ -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.

@@ -35,7 +35,7 @@ Your Enterprise Edition is now active.

 ## Order the Enterprise Edition

-If you want to **order the Enterprise Edition** click on the **+ Order Enterprise Edition** button shown on the page. You can also [request a trial token](./enterprise-trial) to test the premium features included in the Enterprise Edition.
+If you want to **order the Enterprise Edition** click on the **+ Order Enterprise Edition** button shown on the page. You can also [request a trial token](../enterprise-trial) to test the premium features included in the Enterprise Edition.

 ![image-20200120132950106](image-20200120132950106.png)

@@ -1,6 +1,15 @@
-# Getting Started guide
+---
+sidebar_navigation:
+  title: Getting started
+  priority: 999
+description: OpenProject getting started guide.
+robots: index, follow
+keywords: getting started guide
+---

-Welcome to the OpenProject **Getting Started guide**.
+# 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/).

@@ -1,8 +1,10 @@
 ---
-title: Introduction to Boards
-description: Get an introduction to Agile Boards
+sidebar_navigation:
+  title: Boards introduction
+  priority: 500
+description: Introduction to boards in OpenProject.
 robots: index, follow
-keywords: invite members
+keywords: boards introduction
 ---

 # Introduction to agile Boards (Premium feature)
@@ -11,6 +13,9 @@ In this document you will get a first introduction to the Boards in OpenProject,

 To find out more about the functionalities of Boards, please visit our [user guide for boards](../../user-guide/agile-boards).

+Agile board is a premium feature and only available for [OpenProject Cloud Edition](https://www.openproject.org/hosting/) and [Enterprise Edition](https://www.openproject.org/enterprise-edition/) customers.
+
+
 | Feature                                                    | Documentation for                          |
 | ---------------------------------------------------------- | ------------------------------------------ |
 | [What is a Board?](#what-is-a-board?)                      | Find out what is a Board in OpenProject.   |
@@ -1,8 +1,10 @@
 ---
-title: Introduction to Gantt charts
-description: Introduction to Gantt charts
+sidebar_navigation:
+  title: Gantt charts introduction
+  priority: 600
+description: Introduction to Gantt charts to OpenProject.
 robots: index, follow
-keywords: gantt charts
+keywords: Gantt charts introduction
 ---

 # Introduction to Gantt charts
@@ -1,16 +1,17 @@
 ---
-title: Invite members
-description: Invite new team members to a project
+sidebar_navigation:
+  title: Invite members
+  priority: 800
+description: Invite team members to OpenProject.
 robots: index, follow
 keywords: invite members
 ---

-# Invite team members
+# Invite members

-In order to see a project and work in it, you have to be a member of a project. Therefore, you have to add team members to a project.
+In order to see a project and work in it, you have to be a member of a project. Therefore, you have to **add team members to a project**.

 <div class="alert alert-info" role="alert">
-
 **Note**: If you are not a member of a project, you do not see the project in the Project selection nor in the project list.

 </div>
@@ -1,8 +1,10 @@
 ---
-title: My Account
-description: Learn how to configure your account
+sidebar_navigation:
+  title: My Account
+  priority: 400
+description: Learn how to configure account settings.
 robots: index, follow
-keywords: account configuration
+keywords: my account, account settings
 ---

 # My Account
@@ -1,13 +1,15 @@
 ---
-title: My Page
-description: Learn how to set up a personal project dashboard
+sidebar_navigation:
+  title: My Page
+  priority: 300
+description: My Page in OpenProject.
 robots: index, follow
 keywords: my page
 ---

 # 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                                  |
 | ------------------------------------------------------------ | -------------------------------------------------- |
@@ -1,10 +1,11 @@
 ---
-title: Introduction to OpenProject
-description: Get and introduction to OpenProject - open source project management software.
+sidebar_navigation:
+  title: Introduction to OpenProject
+  priority: 999
+description: Get and introduction to OpenProject.
 robots: index, follow
-keywords: introduction to OpenProject
+keywords: OpenProject introduction
 ---
-
 # Introduction to OpenProject

 Welcome to OpenProject! We are glad to have you here. In this section we will cover an introduction to project management with OpenProject as well as general topics regarding OpenProject.
@@ -1,18 +1,24 @@
 ---
-title: Open and create a project
-description: Open and create a new project in OpenProject. 
+sidebar_navigation:
+  title: Projects
+  priority: 900
+description: Introduction to projects in OpenProject.
 robots: index, follow
-keywords: open project, create project
+keywords: open project, create project, projects introduction
 ---
+# Projects introduction

-# Projects
+Get an introduction how to work with projects in OpenProject. To start collaboration in OpenProject, you first have to set up a new project.
+
+<div class="alert alert-info" role="alert">
+**Note**: In order to see a project and work in it, you have to be a [member of a project](../invite-members).

-To start collaboration in OpenProject, you first have to set up a new project.

 | Feature                                                 | Documentation for                                     |
 | ------------------------------------------------------- | ----------------------------------------------------- |
-| [Select a project](#open-an-existing-project)           | Open an existing project.                             |
+| [Open project](#open-an-existing-project)               | Select and open an existing project.                  |
 | [Create a new project](#create-a-new-project)           | How to create a new project?                          |
+| [View all projects](#view-all-projects)                 | How to get an overview about all my projects?         |
 | [Advanced project settings](#advanced-project-settings) | Configure further advanced settings for your project. |

 ## Open an existing project
@@ -65,8 +71,6 @@ You will see a list with all your projects and its details.



+## Advanced Project Settings

-
-### Advanced Project Settings
-
-Optionally, you can find out how to configure further [advanced settings](#TODO) for your projects, e.g. description, project hierarchy or setting it to public.
+In our detailed user guide you can find out how to configure further [advanced project settings](../../user-guide/projects/) for your projects, e.g. description, project hierarchy or setting it to public.
@@ -1,10 +1,11 @@
 ---
-title: Sign in and registration
-description: Find out more about the sign in and registration in OpenProject. 
+sidebar_navigation:
+  title: Sign in and registration
+  priority: 990
+description: Sign in and registration in OpenProject.
 robots: index, follow
-keywords: Sign in OpenProject, registration OpenProject
+keywords: sing in, login, registration
 ---
-
 # Sign in and registration

 Here you will get an overview how to sign in and register to an existing OpenProject installation.
@@ -1,8 +1,10 @@
 ---
-title: Introduction to Work Packages
-description: Learn the first steps about work packages
+sidebar_navigation:
+  title: Work packages introduction
+  priority: 700
+description: Introduction to work packages in OpenProject.
 robots: index, follow
-keywords: introduction work packages
+keywords: work packages introduction
 ---

 # Introduction to Work Packages
@@ -6,21 +6,38 @@ description: Configure backlogs in OpenProject.
 robots: index, follow
 keywords: configure backlogs
 ---
-# Backlogs
+# Backlogs configuration

-Coming soon!
+Configure your backlogs settings in OpenProject.

-## Overview
+Navigate to -> *Administration* -> *Backlogs* -> *Settings* to set up your backlogs.

-| Popular Topics | Description |
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
+You can configure the following in the backlogs settings.

+1. Set the work package types which should be used as **story types**. Press Ctrl. to choose several types. The story types will appear in the Backlogs view (product backlog, wish list, sprint) and can be created, prioritized directly in the Backlogs view, e.g. EPIC, FEATURE, BUG.
+2. Set the **task type**. The task type will appear in the task board to manage in your daily stand ups.
+3. Define to **show burn-down or burn-up** chart.
+4. Set a template for **sprint wiki page**. If you create a wiki page with this name, e.g. sprintwiki, you will set up a new wiki page based on this template if you open it via the sprint drop-down menu in the backlogs view. This way, you can easily create templates for sprint review meetings or retrospectives.
+5. Press the blue **apply** button to save your changes.
+
+![Sys-admin-backlogs](Sys-admin-backlogs-1579854523349.png)
+
+## Configure story cards to export
+
+Some Scrum teams also want to export their story cards to put them on a physical board. You can export your story cards and set a certain format for this export.
+
+Navigate to -> *Administration* -> *Backlogs* -> *Export Card Configs* in order to set a new story card configuration.
+
+Press the green **+ Export Card Config** button to create a new story card export configuration.
+
+![story card export configuration](image-20200124093824243.png)
+
+1. Give a **name** for your story card export configuration.
+2. You can add a **description**.
+3. Define how many work packages (as defined as story types in the above settings, e.g. user stories) should be **printed per page**.
+4. Set the **page size**.
+5. Choose **landscape** or **portrait** for printing option.
+6. **Set rows configuration**. See the help icon with the question mark for further information regarding the row formatting.
+7. Press the blue **Create** button to save your changes.
+
+![Sys-admin-backlogs-export-story-card-config](Sys-admin-backlogs-export-story-card-config.png)
@@ -8,16 +8,53 @@ keywords: budgets
 ---
 # Budgets

-You can configure costs in OpenProject and can create cost types.
+You can configure costs in OpenProject and create cost types to track unit costs.

 Navigate to -> *Administration* -> *Budgets*.

 ## Settings

-Define settings for OpenProject costs.
+Navigate to -> *Administration* -> *Budgets* -> *Settings* to 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)
+![Sys-admin-configure-costs](Sys-admin-configure-costs.png)
+
+## Create and manage cost types
+
+You can create and manage **cost types** to [book unit costs to work packages in OpenProject](../../user-guide/time-and-costs/cost-tracking/).
+
+Navigate to -> *Administration* -> *Budgets* -> *Cost types* to create and manage unit costs types.
+
+Click the green **+ Cost type** button to create a new cost type.
+
+![Sys-admin-budgets-create-cost-types](Sys-admin-budgets-create-cost-types.png)
+
+You can set the following options:
+
+1. Give the cost type a **name**.
+2. Define the **unit name** for this cost type, e.g. Euro, piece, day, etc.
+3. Set the **pluralized unit name**, e.g. Euros, pieces, days, etc.
+4. Choose if the cost type should be the **default cost type** when booking new unit costs.
+5. Define the Rate history and **set a date** from which this cost type should be valid and **set a rate** (in the specified unit) for this date.
+6. With the + icon you can add **additional rates for other dates**.
+7. The delete icon will **remove a rate** for a certain date.
+8. Do not forget to **save** your changes.
+
+![Sys-admin-budgets-cost-types](Sys-admin-budgets-cost-types.png)
+
+In the overview list of all rates you can define the following.
+
+1. **Filter for cost types at a certain fixed date** in the list, 2. choose whether also locked cost types should be displayed and 3. press the blue apply button: This way you will get the cost types with the rate (at the chosen fixed date) displayed in the list below.
+
+4. Click on the name of a cost type to **edit an existing cost type**.
+5. **Set a current rate** (for the current valid from period) and press the save icon to apply it.
+6. **Lock** a cost type.
+
+![Sys-admin-budgets-cost-types-list](Sys-admin-budgets-cost-types-list-1579853898118.png)
+
+<div class="alert alert-info" role="alert">
+**Note**: With cost types you can also book any kind of units to work packages, e.g. vacation days, leaves, travel days, etc.. Just choose 1 as a unit. This way, you could e.g. track vacation days against a vacation budget and evaluate the days in the [cost reporting](../../user-guide/time-and-costs/reporting/).
+</div>
@@ -45,4 +45,4 @@ In the list of all projects you will see the project custom field displayed as a

 ![Sys-admin-display-project-custom-field](Sys-admin-display-project-custom-field.png)

- Furthermore, the project custom field will also be displayed in the Project details widget on the [project overview page](../user-guide/project-overview/).
+Furthermore, the project custom field will also be displayed in the Project details widget on the [project overview page](../../../user-guide/project-overview/).
@@ -30,4 +30,8 @@ You will then be able to name the value, activate it and choose if it should be
 4. You can move the enumerations in the list of possible values up or down with the sort.
 5. To remove an enumeration click on the respective **delete icon**.

-![Sys-admin-enumerations](Sys-admin-enumerations.png)
+![Sys-admin-enumerations](Sys-admin-enumerations.png)
+
+**Note**: To activate the [Activities (for time tracking)](../../user-guide/project-settings/activities-time-tracking) in a certain project, navigate to -> *Project settings* -> *Activities (time tracking)*.
+</div>
+
@@ -8,19 +8,36 @@ keywords: system information
 ---
 # System information

-Coming soon!
+You get an overview about current system status and more information. Navigate to -> *Administration* -> *Information*.

-## Overview
+1. Displays the **product version** (OpenProject configuration).

-| Popular Topics | Description |
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
+2. Displays the core version of your OpenProject installation.

+![Sys-admin-information](Sys-admin-information.png)
+
+## Security badge
+
+The **Security badge** shows the current status of your OpenProject installation. It will inform administrators of an OpenProject installation on whether new releases or security updates are available for your platform.
+
+If enabled, this option will display a badge with your installation status at Administration > Information right next to the release  version, and on the home screen. It is only displayed to administrators.
+
+The badge will match your current OpenProject version against the official OpenProject release database to alert you of any updates or  known vulnerabilities. To ensure the newest available update can be returned, the check will  include your installation type, current version, database type,  enterprise status and an anonymous unique ID of the instance. To localize the badge, the user's locale is sent. No personal  information of your installation or any user within is transmitted,  processed, or stored.
+
+To disable rendering the badge, uncheck the setting at *Administration* > *System settings* > *General* or pass the configuration flag `security_badge_displayed: false` .
+
+## Additional system information
+
+There are a few automatic checks from the system to ensure the safety and correct set up of your configuration if you navigate to -> *Administration* -> *Information*.
+
+If one point is not fulfilled, e.g. changing the default administrator account, you will get a warning message in the form of a bug icon.
+
+![system information](image-20200124104411677.png)
+
+## Storage information
+
+You will get information about the storage filesystem in your OpenProject application if you navigate to -> *Administration* -> *Information*.
+
+You will see the remaining disk space as well as used disk space in your OpenProject installation.
+
+![storage filestystem information](image-20200124104803476.png)
@@ -1,16 +0,0 @@
-# Manage Enterprise Features
-
-In OpenProject some features are only available for the Enterprise or Cloud Edition customers. Find out how to configure these Enterprise Features in the System Administration.
-
-| Popular Topics                         | Description |
-| -------------------------------------- | :---------- |
-| Design (Custom theme and logo)         |             |
-| Single Sign-on                         |             |
-| Two-factor authentication              |             |
-| LDAP user and group synch              |             |
-| Attribute help texts                   |             |
-| Custom actions (intelligent workflows) |             |
-|                                        |             |
-|                                        |             |
-|                                        |             |
-
@@ -1,19 +0,0 @@
---
-title: Design (Custom theme and logo)
-description: Manage your design with custom theme and logo in OpenProject
-robots: index, follow
-keywords: design, custom theme, logo
---
-
-# Design (Custom theme and logo)
-
-XX
-
-| Feature                                                      | Documentation for |
-| ------------------------------------------------------------ | ----------------- |
-| TODO |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-
@@ -1,19 +0,0 @@
---
-title: Help texts
-description: Manage help texts for work package attributes in OpenProject
-robots: index, follow
-keywords: help texts
---
-
-# Help texts
-
-XX
-
-| Feature                                                      | Documentation for |
-| ------------------------------------------------------------ | ----------------- |
-| TODO |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-
@@ -1,19 +0,0 @@
---
-title: Manage projects
-description: Manage your projects in OpenProject
-robots: index, follow
-keywords: manage projects
---
-
-# Manage Projects
-
-XX
-
-| Feature                                                      | Documentation for |
-| ------------------------------------------------------------ | ----------------- |
-| TODO |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-
@@ -8,19 +8,10 @@ keywords: plugins
 ---
 # Plugins

-Coming soon!
+The OpenProject configurations contains a certain amount of plugins which are listed under -> *Administration* -> *Plugins*.

-## Overview
+We recommend to use the plugins as suggested in our deployement packages. You will get more detailed information (about current changes, author, etc.) if you follow the links.

-| Popular Topics | Description |
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
+![OpenProject plugins](image-20200124100220714.png)

+If you want to write your own plugin, please follow our [development guide](../../development/create-openproject-plugin). 
@@ -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).        

@@ -8,19 +8,25 @@ keywords: webhooks
 ---
 # Webhooks

-Coming soon!
+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.

-## Overview
+Navigate to -> *Administration* -> *Webhooks* to set up your webhooks in OpenProject.

-| Popular Topics | Description |
-| -------------- | :---------- |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
-|                |             |
+Press the green **+ Webhook** button to add a new webhook to OpenProject.

+![Sys-admin-webhooks](Sys-admin-webhooks.png)
+
+
+
+You can configure the following options for webhooks:
+
+1. Choose a **name** identifying the webhook.
+2. **Payload URL** defines the endpoint, called when the webhook is triggered.
+3. Freely choose an additonal **description** to further identify the intent of the respective webhook.
+4. By defining a **Siganture secret** you guarantee that the sender of the payload request is actually OpenProject. The client will then check this signature secret.
+5. Enable if the webhook should be active.
+6. Set the events for which the webhook should be activate, i.e. webhook for updating or creating work packages, or for creating time entries.
+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.
+
+![Sys-admin-webhooks-configuration](Sys-admin-webhooks-configuration.png)
@@ -8,16 +8,28 @@ keywords: project settings
 ---
 # Project settings

-asdf
+Customize your project in the project settings.
+
+Open a project via the Select a project drop-down menu and navigate to -> *Project settings* in the project menu.
+
+![User-guide-open-project-settings](User-guide-open-project-settings.png)
+
+<div class="alert alert-info" role="alert">
+**Note**: You have to be a project admin in order to see and access to project settings.
+</div>
+
+
+## Overview
+
+| Feature                                                | Documentation for                                            |
+| ------------------------------------------------------ | ------------------------------------------------------------ |
+| [Project information](project-information)             | Define project name, subproject, description, project status, and much more. |
+| [Modules](modules)                                     | Activate or deactivate modules in a project.                 |
+| [Work package types](work-package-types)               | Activate or deactivate work package types in a project.      |
+| [Work package categories](work-package-categories)     | Create and manage work package categories.                   |
+| [Custom fields](custom-fields)                         | Activate or deactivate custom fields for a project.          |
+| [Versions](versions)                                   | Create and manage versions in a project.                     |
+| [Repository](repository)                               | Activate and manage a SVN or GIT repository for a project.   |
+| [Activities (time tracking)](activities-time-tracking) | Activate or deactivate Activities (for time tracking) in a project. |
+| [Backlogs settings](backlogs-settings)                 | Manage backlogs settings for a project.                      |

-| Feature                               | Documentation for                         |
-| ------------------------------------- | ----------------------------------------- |
-| [Select a project](#select-a-project) | Open a project which you want to work at. |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
-|                                       |                                           |
@@ -0,0 +1,18 @@
+---
+sidebar_navigation:
+  title: Activites for time tracking
+  priority: 300
+description: Manage activites for time tracking.
+robots: index, follow
+keywords: activities for time tracking
+---
+# Manage activites for time tracking
+
+You can configure Activities for time tracking in the System *Administration* -> *Enumerations*. You can activate or deactivate time tracking acitivites per project.
+
+Navigate to the -> Project settings -> *Activites (time tracking)*.
+
+Select the activites which you want to activate for time tracking in your project.
+
+![activites for time tracking](image-20200127151125469.png)
+
@@ -0,0 +1,24 @@
+---
+sidebar_navigation:
+  title: Backlogs settings
+  priority: 200
+description: Backlogs settings.
+robots: index, follow
+keywords: backlogs settings
+---
+# Backlogs settings
+
+Configure your backlogs settings for a project.
+
+## Set the definition of done
+
+You can set the definition of done for your backlogs module. This defines when a work packages should be treated as being done and calculated to the burndown (or burnup chart).
+
+Choose the status which should be treated as done.
+
+Press the blue **Save** button to apply your changes.
+
+![definition of done](image-20200127152832013.png)
+
+The **Rebuild positions button** for the backlogs re-calculates the position of a work package in the product backlog.
+
@@ -1,24 +1,24 @@
 ---
 sidebar_navigation:
  title: Custom fields
-  priority: 
+  priority: 700
 description: Manage custom fields in a project.
 robots: index, follow
 keywords: custom fields
 ---
-# Manage custom fields in projects
+# Enable custom fields in projects

-Coming soon!
+**Custom fields can be activated or deactivated in a project**. Open the respective project and go to -> *project settings* -> *custom fields*.

-| Feature | Documentation for |
-| ------- | ----------------- |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
+1. Manage the custom field by clicking on the name. You have to be a System Administrator in order to [manage custom fields in the system administration](../../syste-admin-guide/custom-fields).
+2. **Select if the custom fields shall be enabled in the project**. If enabled globally in the custom fields settings, it will automatically be displayed in all projects.
+3. View the work package types for which the custom field is already enabled. Only for the displayed types the custom field will be active.
+4. **Create a new custom field** with the green + Custom field button. You have to be a system administrator in order to create new custom fields.
+5. Press the blue **Save** button to confirm your changes.

+![User-guide-project-settings-custom-fields](User-guide-project-settings-custom-fields.png)
+
+
+<div class="alert alert-info" role="alert">
+**Note**: Custom fields first need to be created in the System Administration -> Custom fields. Then, they can be activated for certain projects if they are not globally enabled for all projects.
+</div>
@@ -0,0 +1,18 @@
+---
+sidebar_navigation:
+  title: Modules
+  priority: 900
+description: Enable modules in a project.
+robots: index, follow
+keywords: modules
+---
+# Enable modules in a project
+
+To **activate or deactivate modules** in a project select a project from the select a project drop-down menu in the left header navigation and choose -> *Project settings* -> *Modules*.
+
+Setting a check mark next to a project module, the module will be enabled in the project and a new menu item will appear in the project menu.
+
+![enable modules](image-20200127135759829.png)
+
+Visit our [user guide](../../) overview to choose an explanation of the different modules in OpenProject.
+
@@ -0,0 +1,32 @@
+---
+sidebar_navigation:
+  title: Project information
+  priority: 990
+description: General project information.
+robots: index, follow
+keywords: project information
+---
+# Manage project information
+
+Manage your project information in the Project settings: select a project and open the -> *Project Settings* -> *Information*.
+
+**To view all details about managing projects**, view our [projects section](../../projects).
+
+You will have the following options in the project settings.
+
+1. Set a **name for your project**. The name will be displayed in the project list.
+2. Set **custom fields**, e.g. Project ID, Project accountable, etc. (if activated in the -> *Administration* -> *Custom fields* -> within the custom fields for projects).
+3. Select the **parent project**.
+4. Add a project **description**.
+5. Display or edit the **project identifier**. This is the part of the project name shown in the URL, e.g. /demo-project.
+6. The a project to **public**. This ways users will be able to access the project without logging in.
+7. Set a **project status**. The project status can be displayed in the [project overview](../../project-overview).
+8. Ad a **project status description**. The status description will be shown on the [project overview](../../project-overview) page.
+9. Display the required disk storage information.
+10. **Save** your changes.
+11. **Create a new subproject** for this project with the green **+ Subproject** button.
+12. **Copy the project**. When [copying a project](../../projects/#copy-a-project) you can choose which modules you will copy.
+13. **Archive a project**. This way the [archived project](../../projects/#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. **Delete a project**. By [deleting a project](../../projects/#delete-a-project) the whole project will all included information will be removed.
+
+![User-guide-project-settings](User-guide-project-settings.png)
@@ -0,0 +1,23 @@
+---
+sidebar_navigation:
+  title: Repository
+  priority: 400
+description: Manage a repository in a project.
+robots: index, follow
+keywords: repository
+---
+# Manage a repository
+
+You can integrate a SVN or GIT repository in a project in OpenProject and access it directly in the project via the module Repositories.
+
+**Note**: Repositories can only be integrated for Community Edition and Enterprise Edition (self hosted) versions.
+</div>
+
+Navigate to -> *Project settings* -> *Repository*.
+
+1. Choose a **source control management system** (SVN or GIT).
+2. Enter the URL of your existing repository.
+3. Enter username and password for your repository.
+4. Press the blue **Create** button.
+
+![User-guide-project-settings-repository](User-guide-project-settings-repository.png)
@@ -0,0 +1,40 @@
+---
+sidebar_navigation:
+  title: Versions
+  priority: 600
+description: Manage versions in OpenProject.
+robots: index, follow
+keywords: manage versions
+---
+# Manage versions
+
+Versions will be used, e.g. for roadmap planning to track certain product versions or releases. Work packages can be assigned to a version. They will be displayed in the [Roadmap](../../roadmap).
+
+Also, version will  be used to enable the Backlogs module, i.e. to create a product backlog and sprints in OpenProject.
+
+## Create a new version
+
+Press the green **+ Version** button to create a new version for a project.
+
+![User-guide-project-settings-versions](User-guide-project-settings-versions.png)
+
+You can configure the following information.
+
+1. Set a **name** for the version.
+2. Add a **description** to specify the version.
+3. Set **status** of a version, the default status is open.
+4. Choose a **wiki page** that you want to open dirctly from a version in the Roadmap.
+5. Set a **start date and finish date** for the version.
+6. Choose whether the version shall be **shared** with other projects, e.g. in the project hierarchy or subprojects.
+7. Select a **column in backlogs view**. This is only required if you use the versions to manage your [Scrum backlog](../../backlogs-scrum).
+8. Press the blue **Create** button to save your changes.
+
+![User-guide-project-settings-create-version](User-guide-project-settings-create-version.png)
+
+## Edit or delete versions
+
+1. Click on the name of a version to **edit** it.
+2. Press the **delete** button at the right of the version to delete a version.
+3. You can **close all completed versions** with the button at the bottom of the list. In order to close only certain versions, open the details view and adapt the version **Status** (see above).
+
+![User-guide-project-settings-edit-versions](User-guide-project-settings-edit-versions.png)
@@ -0,0 +1,11 @@
+---
+sidebar_navigation:
+  title: Versions for Backlogs (Scrum)
+  priority: 600
+description: Manage versions for Backlogs in OpenProject.
+robots: index, follow
+keywords: manage versions backlogs
+---
+# Manage versions for Backlogs (Scrum)
+
+Coming soon!
@@ -0,0 +1,37 @@
+---
+sidebar_navigation:
+  title: Work package categories
+  priority: 500
+description: Manage work package categories.
+robots: index, follow
+keywords: work package categories
+---
+# Manage work package categories
+
+In the work package forms you have the default attribute to select **work package categories** to differentiate work packages, filter, and group by certain attributes.
+
+You can manage these work package categories in the -> *Project settings* -> *Work package categories*.
+
+## Create a new work package category
+
+Press the green **+ Category** button to create a new category for a project.
+
+![User-guide-project-settings-work-package-categories](User-guide-project-settings-work-package-categories.png)
+
+You can enter the following information.
+
+1. **Name** your category
+2. Choose a default **Assignee** if the work package has this category.
+3. Press the blue **Create** button.
+
+![User-guide-project-settings-create-category](User-guide-project-settings-create-category.png)
+
+## Edit or delete a category
+
+From the list of categories you can choose a category to edit or delete.
+
+1. Press the **edit** button to make changes to a category.
+
+2. Press the **delete** button to delete a category.
+
+   ![User-guide-project-settings-edit-category](User-guide-project-settings-edit-category.png)
@@ -1,24 +1,20 @@
 ---
 sidebar_navigation:
  title: Work package types
-  priority: 
+  priority: 800
 description: Enable or disable work package types in a project.
 robots: index, follow
 keywords: work package types
 ---
 # Work package types

-Coming soon!
+**Activate or deactivate work package types for a project**. 
+Select the respective project via the project drop-down menu at the top left in the header navigation and choose -> *Project settings* -> *Work package types* in the project menu.

-| Feature | Documentation for |
-| ------- | ----------------- |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
-|         |                   |
+![enable work package types](image-20200127140623978.png)

+Check the different types which you want to enable for your project. In the table you will also see if the work package types is displayed in the roadmap by default and if it is a milestone.
+
+Press the blue **Save** button to confirm your changes.
+
+[Work package types can be managed](../../system-admin-guide/work-packages/work-package-types) in the System *Administration* -> *Work packages* -> *Types*.
@@ -9,7 +9,19 @@ keywords: application start page

 # Application start page

-Coming soon!
+On the **application start page** (home page) you will get an overview about important information.

-![application start page](image-20200122165814704.png)
+To get to the application start page, click on the logo in the header of the application.

+![User-guide-application-start-page](User-guide-application-start-page.png)
+
+1. **Welcome text block** to welcome your team members, share important project information, or any other information. You can configure the [welcome text](../../system-admin-guide/system-settings/general-settings/#welcome-block-text) block under -> *Administration* -> *System settings* -> *General*.
+2. The **projects block** displays your latest project. You can [create a new project](../../getting-started/#create-project) or [view all projects](../../getting-started/projects/#view-all-projects).
+3. The **new features block** displays latest feature announcements and developments.
+4. The **Users block** displays latest registered users on the instance. You can [invite new users](../../getting-started/invite-members/) with the green **+ Invite users** button.
+5. The **My Account block** links to important account settings, such as the [user profile](../../getting-started/my-account/#edit-your-user-information), the [My page](../../getting-started/my-page/), and the [change password](../../getting-started/sign-in-registration/#reset-your-password) section.
+6. The **latest news block** displays latest news from all your projects. Click on the link of the news to read the details.
+7. The **OpenProject Community block** displays links to important community information, such as release notes, forum, or the API documentation.
+8. **Administration block** displays links to important system administration resources. Also, the [application security badge](../../system-admin-guide/system-settings/general-settings/) will be displayed when activated.
+9. The **Billing block** will be displayed for the [OpenProject Cloud Edition](../../cloud-edition-guide). The **Enterprise Edition** block will be displayed for the [OpenProject Enterprise Edition](../../enterprise-edition-guide)). You will get links to the respective section.
+10. At the bottom of the page, you will get links to **user guides, glossary, system shortcuts, and the community forum**.