Commit project settings

pull/7998/head
birthe 5 years ago
parent 59712a0c89
commit a244906031
  1. 1
      help/getting-started/my-account/README.md
  2. 6
      help/system-admin-guide/enumerations/README.md
  3. 8
      help/user-guide/project-settings/README.md
  4. 28
      help/user-guide/project-settings/activities-time-tracking/README.md
  5. BIN
      help/user-guide/project-settings/activities-time-tracking/image-20200127151125469.png
  6. 38
      help/user-guide/project-settings/backlogs-settings/README.md
  7. BIN
      help/user-guide/project-settings/backlogs-settings/image-20200127152832013.png
  8. 28
      help/user-guide/project-settings/custom-fields/README.md
  9. BIN
      help/user-guide/project-settings/custom-fields/User-guide-project-settings-custom-fields.png
  10. 28
      help/user-guide/project-settings/modules/README.md
  11. BIN
      help/user-guide/project-settings/modules/image-20200127135759829.png
  12. 38
      help/user-guide/project-settings/project-information/README.md
  13. BIN
      help/user-guide/project-settings/project-information/User-guide-project-settings.png
  14. 33
      help/user-guide/project-settings/repository/README.md
  15. BIN
      help/user-guide/project-settings/repository/User-guide-project-settings-repository.png
  16. 54
      help/user-guide/project-settings/versions/README.md
  17. BIN
      help/user-guide/project-settings/versions/User-guide-project-settings-create-version.png
  18. BIN
      help/user-guide/project-settings/versions/User-guide-project-settings-edit-versions.png
  19. BIN
      help/user-guide/project-settings/versions/User-guide-project-settings-versions.png
  20. 11
      help/user-guide/project-settings/versions/versions-backlogs/README.md
  21. 51
      help/user-guide/project-settings/work-package-categories/README.md
  22. BIN
      help/user-guide/project-settings/work-package-categories/User-guide-project-settings-create-category.png
  23. BIN
      help/user-guide/project-settings/work-package-categories/User-guide-project-settings-edit-category.png
  24. BIN
      help/user-guide/project-settings/work-package-categories/User-guide-project-settings-work-package-categories.png
  25. 22
      help/user-guide/project-settings/work-package-types/README.md
  26. BIN
      help/user-guide/project-settings/work-package-types/image-20200127140623978.png
  27. 16
      help/user-guide/start-page/README.md
  28. BIN
      help/user-guide/start-page/User-guide-application-start-page.png

@ -4,6 +4,7 @@ sidebar_navigation:
priority: 400
description: Learn how to configure account settings.
robots: index, follow
keywords: my account, account settings
---
# My Account

@ -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>

@ -14,6 +14,11 @@ Open a project via the Select a project drop-down menu and navigate to -> *Proje
![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 |
@ -26,4 +31,5 @@ Open a project via the Select a project drop-down menu and navigate to -> *Proje
| [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. |
| [Backlogs settings](backlogs-settings) | Manage backlogs settings for a project. |

@ -1,24 +1,18 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Activites for time tracking
priority: 300
description: Manage activites for time tracking.
robots: index, follow
keywords: project settings
keywords: activities for time tracking
---
# Manage project settings
# Manage activites for time tracking
Coming soon!
You can configure Activities for time tracking in the System *Administration* -> *Enumerations*. You can activate or deactivate time tracking acitivites per project.
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

@ -1,24 +1,24 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Backlogs settings
priority: 200
description: Backlogs settings.
robots: index, follow
keywords: project settings
keywords: backlogs settings
---
# Manage project settings
Coming soon!
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
# 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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

@ -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>

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

@ -1,24 +1,18 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Modules
priority: 900
description: Enable modules in a project.
robots: index, follow
keywords: project settings
keywords: modules
---
# Manage project settings
# Enable modules in a project
Coming soon!
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*.
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

@ -2,23 +2,31 @@
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
description: General project information.
robots: index, follow
keywords: project settings
keywords: project information
---
# Manage project settings
# Manage project information
Coming soon!
Manage your project information in the Project settings: select a project and open the -> *Project Settings* -> *Information*.
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
**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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 235 KiB

@ -1,24 +1,23 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Repository
priority: 400
description: Manage a repository in a project.
robots: index, follow
keywords: project settings
keywords: repository
---
# Manage project settings
# Manage a repository
Coming soon!
You can integrate a SVN or GIT repository in a project in OpenProject and access it directly in the project via the module Repositories.
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
**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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

@ -1,24 +1,40 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Versions
priority: 600
description: Manage versions in OpenProject.
robots: index, follow
keywords: project settings
keywords: manage versions
---
# Manage project settings
Coming soon!
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
# 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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

@ -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!

@ -1,24 +1,37 @@
---
sidebar_navigation:
title: Project information
priority: 990
description: Project settings in a project.
title: Work package categories
priority: 500
description: Manage work package categories.
robots: index, follow
keywords: project settings
keywords: work package categories
---
# Manage project settings
Coming soon!
| Feature | Documentation for |
| ------- | ----------------- |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
# 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*.

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

@ -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**.

Binary file not shown.

After

Width:  |  Height:  |  Size: 340 KiB

Loading…
Cancel
Save