Changes to System Admin Guide

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

@@ -1,19 +1,23 @@
 ---
-title: Configure Work Package Types
-description: Configure Work Package Types in OpenProject
+sidebar_navigation:
+  title: Manage work packages
+  priority: 980
+description: Manage work packages in OpenProject.
 robots: index, follow
-keywords: work package types
+keywords: manage work packages
 ---
+# Manage work packages
 
-# Configure Work Package Types
+Manage work packages in OpenProject.
 
-XX
+## Overview
 
-| Feature                                                      | Documentation for |
-| ------------------------------------------------------------ | ----------------- |
-| TODO |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
+| Popular Topics                               | Description                                                  |
+| -------------------------------------------- | :----------------------------------------------------------- |
+| [Settings](work-package-settings)            | Configure general work package settings and defaults, such as display options and more. |
+| [Types](work-package-types)                  | Create and manage work package types.                        |
+| [Status](work-package-status)                | Create and manage work package status.                       |
+| [Workflows](work-package-workflows)          | Create and manage workflows for work packages in OpenProject. |
+| [Custom actions](custom-actions)             | Create custom actions for work packages (Premium feature)    |
+| [Attribute help texts](attribute-help-texts) | Create and manage attribute help texts in OpenProject (Premium feature) |
 

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

@@ -0,0 +1,37 @@
+---
+sidebar_navigation:
+  title: Settings
+  priority: 999
+description: Work package settings in OpenProject.
+robots: index, follow
+keywords: work package settings
+---
+# Work package settings
+
+To change basic settings for work package tracking in OpenProject, navigate to the -> *Administration* -> *Work packages* -> *Settings*.
+
+![work package settings](image-20200116131607856.png)
+
+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.
+
+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.
+
+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.
+
+   ![default highlighting mode](image-20200116133247958.png)
+
+8. Customize the appearance of the work package lists to **define which work package properties are displayed in the work package lists by default** and for which properties sums are displayed.
+
+Do not forget to save your changes with the blue **Save** button at the bottom.
+
+![Sys-admin-work-package-settings](Sys-admin-work-package-settings.png)

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

@@ -1,19 +1,87 @@
 ---
-title: Configure Work Package Types
-description: Configure Work Package Types in OpenProject
+sidebar_navigation:
+  title: Types
+  priority: 980
+description: Configure work package types in OpenProject.
 robots: index, follow
 keywords: work package types
 ---
 
-# Configure Work Package Types
+# Manage Work Package Types
 
-XX
+You can have as many work package types in the system as needed, e.g. Tasks, Bugs, Ideas, Risks, Features.
 
-| Feature                                                      | Documentation for |
-| ------------------------------------------------------------ | ----------------- |
-| TODO |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
-|                                                              |                   |
+In the -> Administration -> Work packages -> Types you can add or edit the work package types.
 
+You will see a list of all work package types in the system.
+
+1. Click the work package type name to **edit an existing work package type**.
+2. Click the arrows (up or down) to change the order how work package types should be displayed, e.g. in the list when creating new work packages or when changing the type.
+3. Delete work package types.
+
+![Sys-admin-work-package-types-list](Sys-admin-work-package-types-list-1579179143954.png)
+
+## Create new work package type
+
+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).
+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.
+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.
+
+![Sys-admin-add-work-package-type](Sys-admin-add-work-package-type.png)
+
+## Work package form configuration
+
+You can freely **configure the attributes shown** for each work package type to decide which attributes are shown in the from and how they are grouped.
+
+To configure a type, first select the type from the list of types (see above) and select the tab ***Form configuration*** *(1)*.
+
+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.
+
+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/).
+
+In case you made a mistake, click the *Reset to defaults (5)* button to reset all settings to the original state.
+
+Finally, **save** the settings to apply them *(6)*.
+
+​      ![Sys-admin-type-form-configuration](Sys-admin-type-form-configuration-1579181896505.png)
+
+If you then create a new work package of this type, the input form will have exactly these attributes selected in the form configuration.
+
+In this case, all attributes in the blue area on the left are displayed under the corresponding attribute group.
+
+![work package form configuration](image-20200116150227458.png)
+
+## Add table of related work packages to a work package form
+
+Also, you can add a table of related work packages to your work package form. Click the green **+ Group** button and choose **Add table of related work package** from the drop-down list.
+
+![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/).
+
+Click the blue **Apply** button to add this work package list to your form.
+
+![Sys-admin-work-package-table-config](Sys-admin-work-package-table-config.png)
+
+The embedded related work package table in the work package form will look like this. Here, the work packages with the chosen relation will be shown automatically (based on the filtered criteria in the embedded list) or new work packages with this relation can be added. 
+
+![Sys-admin-related-work-package-table](Sys-admin-related-work-package-table.png)
+
+## Activate projects for work package types
+
+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).
+
+![activate projects for work package types](image-20200116150513323.png)

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

@@ -14,9 +14,9 @@ Manage users and permissions in OpenProject.
 
 | Popular Topics                             | Description                                                  |
 | ------------------------------------------ | :----------------------------------------------------------- |
-| [Settings](/settings)                      | Configure user settings, e.g. default language, time zone, and more. |
-| [Users](/users)                            | Manage users: View all users, invite new users, lock users, and more. |
-| [Groups](/groups)                          | View groups, create new groups, add users to groups.         |
+| [Settings](settings)                       | Configure user settings, e.g. default language, time zone, and more. |
+| [Users](users)                             | Manage users: View all users, invite new users, lock users, and more. |
+| [Groups](groups)                           | View groups, create new groups, add users to groups.         |
 | [Roles and permissions](roles-permissions) | See / manage roles and permissions and add new roles.        |
-| [Avatars](/avatars)                        | Activate / deactivate user avatars (profile pictures)        |
+| [Avatars](avatars)                         | Activate / deactivate user avatars (profile pictures)        |
 

help/user-guide/work-packages/work-package-table-configuration/README.md

@@ -15,7 +15,7 @@ keywords: work packages table configuration
 | [Filter work packages](#filter-work-packages)                | How to filter in the work package list?                      |
 | [Sort the work package list](#sort-the-work-package-list)    | How to sort within the work package list?                    |
 | [Display settings](#how-to-switch-from-flat-list-to-hierarchy-mode?) | How to switch from flat list to hierarchy mode in the work package list? |
-| [Attribute highlighting (Premium Feature)](#attribute-highlighting-(premium-feature)) | How to highlight certain attributes in the work package list? |
+| [Attribute highlighting (Premium Feature)](#attribute-highlighting-premium-feature) | How to highlight certain attributes in the work package list? |
 | [Save work package views](#save-work-package-views)          | How to save a new work package view?                         |
 
 You can configure the work package table view in OpenProject to display the information that you need in the list.