-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs for project attributes (including Project overview and new Proje…
…cts admin menu) (#15345) * Added docs for admin side of project attributes Also changed the structure to represent changes to the Admin menu. Still need to add images. * Typos/minor * Updated docs re: Project Overview page * Minor/typos * Added docs for project settings * Update docs/system-admin-guide/custom-fields/custom-fields-projects/README.md * project attributes docs update * project attributes docs changes * fixing links in docs * update * link fix --------- Co-authored-by: Maya Berdygylyjova <MayaBerd@users.noreply.github.com>
- Loading branch information
Showing
30 changed files
with
234 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
sidebar_navigation: | ||
title: Project settings | ||
priority: 100 | ||
description: Adjusting settings for projects in your instance, including defaults for new projects, project attributes and project lists. | ||
keywords: project settings, project attributes, project lists, configuration, new projects | ||
--- | ||
# Project settings | ||
|
||
The **Projects** page lets you configure settings for projects in your instance, including default settings for new projects, project attributes and project lists. | ||
|
||
>**Note:** These settings moved from *Administration → System settings → Projects* to now *Administration → Projects* in version 14.0. | ||
| Topic | Content | | ||
| ---------------------------------------- | ------------------------------------------------------------ | | ||
| [Project attributes](project-attributes) | Viewing, creating and modifying project attributes in OpenProject | | ||
| [New project](new-project) | Choose which modules are enabled by default for new projects and what roles are given to non-admin users who create a project | | ||
| [Project lists](project-lists) | Define which project attributes should be visible as columns in the cross-project global project lists and Gantt views | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_navigation: | ||
title: New project | ||
priority: 200 | ||
description: Choose which modules are enabled by default for new projects and the role given to non-admin users who create a project | ||
keywords: new project, settings, default, modules | ||
--- | ||
|
||
# New project | ||
|
||
To set defaults for new projects, navigate to **Administration settings** → **Projects** → **New project**. | ||
|
||
![New project settings in OpenProject adminstration](open_project_system_guide_new_project_settings.png) | ||
|
||
You will find the following options on this page: | ||
|
||
**New projects are public by default**: Check this option to make new projects public by default when they are created. If this is unchecked, all new projects will be private by default and will have to be marked as public manually. | ||
|
||
- **Default enabled modules for new projects:** The checked modules will be enabled by default when a new project is created. Project admins can enable or disable specific modules later. | ||
- **Role given to a non-admin users who creates project**: The default role you want to assign *in the project* to the user that created it (if this user is not an instance admin). By default, the default role is 'Project admin'. | ||
|
||
Once you make your modifications, click on **Save** to apply the settings instance-wide. |
Binary file added
BIN
+73.3 KB
...n-guide/projects/new-project/open_project_system_guide_new_project_settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 91 additions & 0 deletions
91
docs/system-admin-guide/projects/project-attributes/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
sidebar_navigation: | ||
title: Project attributes | ||
priority: 300 | ||
description: Viewing, creating and modifying project attributes in OpenProject | ||
keywords: project attributes, create, project settings | ||
--- | ||
|
||
# Project attributes (Enterprise add-on) | ||
|
||
> **Please note:** Project attributes are an Enterprise add-on and will only be displayed here for Enterprise on-premises and Enterprise cloud. | ||
Project attributes are custom fields that allow you to communicate key information relevant to a project in the [Project Overview](../../../user-guide/project-overview) page. | ||
|
||
>**Note**: Prior to version 14.0, these were called "project custom fields" and described under the [Custom fields](../../custom-fields/custom-fields-projects/) page. Starting with 14.0, there is now a new entry in the administration section called 'Project attributes' under 'Projects'. | ||
This page describes how to create, order and group project attributes and is directed at instance administrators. If you want know how to enable and set the values for project attributes at a project level, please refer to the [Project Overview](../../../user-guide/project-overview) page of the user guide. | ||
|
||
## View project attributes | ||
|
||
To view all existing project attributes, navigate to **Administration settings** → **Projects** → **Project attributes**. | ||
|
||
![List of existing project attributes in OpenProject administration](open_project_system_admin_guide_project_attributes_list.png) | ||
|
||
Each project attribute will be displayed in individual rows, which contain: | ||
|
||
![OpenProject project attribute explained](open_project_system_guide_project_attribute_explained.png) | ||
|
||
1. The drag handle | ||
2. The project attribute name | ||
3. Format | ||
4. Number of projects using the attribute | ||
5. More button | ||
|
||
Attributes may also be contained in [sections](#sections). | ||
|
||
## Create a project attribute | ||
To create a new project attribute, click on the **+ Project attribute** button in the top right corner. | ||
|
||
This will display the "New attribute" form with these options: | ||
|
||
![Create a new attribute form in OpenProject adminstration](open_project_system_guide_project_attributes_new_attribute.png) | ||
|
||
- **Name**: This is the name that will be visible in the [Project Overview](../../../user-guide/project-overview) page. | ||
|
||
- **Section:** If there are sections, you can pick where this new project attribute should appear. [Learn about sections](#sections) for more information. | ||
|
||
- **Format**: You can pick from nine different types of fields: text, long text, integer, float, list, date, boolean, user and version. | ||
|
||
> **Note**: You cannot change this once the project attribute is created. | ||
- **Format options:** Depending on the type you choose, you might have additional options, such as minimum and maximum width, default value or regular expressions for validation. | ||
|
||
- **Required**: Checking this makes this project attribute a required field in projects where it is enabled, i.e. it cannot be left empty. | ||
|
||
- **Visible**: Checking this field makes the attribute visible to non-admins. | ||
|
||
> **Note**: This is enabled by default. Only disable this if you want this field to be invisible to non-admin users. | ||
- **Searchable**: Checking this makes this project attribute (and its value) available to the search engine and filters. | ||
|
||
|
||
## Modify project attributes | ||
|
||
You can edit existing attributes under **Administration settings** → **Projects** → **Project attributes**. | ||
|
||
![Edit or move a project attribute in the OpenProject administration](open_project_system_admin_guide_project_attributes_more_icon_menu.png) | ||
|
||
Click on the More icon to the right of each project attribute to edit, re-order or delete a project attribute. | ||
|
||
>**Note:** Deleting a project attribute will delete it and the corresponding values for it from all projects. | ||
You can also use the drag handles to the left of each project attribute to drag and drop it to a new position. | ||
|
||
>**Note**: Project admins can chose to enable or disable a project attribute from their project, but they cannot change the order. The order set in this page is the order in which they will appear in all projects. | ||
|
||
## Sections | ||
|
||
You can group project attributes into sections to better organise them. | ||
|
||
You can click on more icon to the right of each section to rename it, delete it or change its order. | ||
|
||
> **Note**: A section can only be deleted if no project attributes were assigned to it. | ||
You can drag any existing project attribute into a section to move it there. You may also drag and drop entire sections up and down to re-order them. | ||
|
||
>**Note:** If a project attribute belongs to a section, it will be displayed within that section in _all_ projects. | ||
![Edit project attribute sections in OpenProject administration](open_project_system_admin_guide_project_attributes_section_more_icon_menu.png) | ||
|
Binary file added
BIN
+82.7 KB
.../project-attributes/open_project_system_admin_guide_project_attributes_list.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+27.4 KB
...ttributes/open_project_system_admin_guide_project_attributes_more_icon_menu.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+32.5 KB
...s/open_project_system_admin_guide_project_attributes_section_more_icon_menu.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+24.6 KB
...ts/project-attributes/open_project_system_guide_project_attribute_explained.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+81.9 KB
...oject-attributes/open_project_system_guide_project_attributes_new_attribute.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
sidebar_navigation: | ||
title: Project lists | ||
priority: 100 | ||
description: Define which project attributes should be visible as columns in the cross-project global project lists and Gantt views | ||
keywords: project attributes, project lists, columns, gantt | ||
--- | ||
|
||
# Project lists | ||
|
||
OpenProject lets users access Project lists, which allow them to get an overview of all projects to which they have access. This page describes how to modify the columns displayed in each project list. For more information on using project lists, read our [user guide on Project lists](../../../user-guide/projects/project-lists). | ||
|
||
To configure project lists, navigate to **Administration settings** → **Projects** → **Project lists**. | ||
|
||
![Project lists in OpenProject administration](open_project_system_guide_projects_project_lists.png) | ||
|
||
## Modify and add columns | ||
|
||
Here, you can view a list of *chips*, or little rectangles with names of project attributes. Each one represents a column in the Project list tables. You can drag and drop these around to change the order in which they appear. | ||
|
||
To add a new project attribute as a column, click on the field with the label **Add columns** (where it says *Select a column*). You will be shown a list of existing project attributes. You can type in a keyword to search through this list and find the project attribute you would like to add. | ||
|
||
## Project portfolio Gantt view | ||
|
||
OpenProject lets users view a list of projects as a Gantt chart. You can edit the default query that is used to display this Gantt chart by clicking on the **Edit query** link. This displays a modal that lets you modify the visible the columns, filters, sort order and other view configuration options. | ||
|
||
![Work package table configuration in OpenProject administration](open_project_system_guide_projects_project_lists_gannt_query.png) |
Binary file added
BIN
+58.5 KB
...ide/projects/project-lists/open_project_system_guide_projects_project_lists.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+39 KB
.../project-lists/open_project_system_guide_projects_project_lists_gannt_query.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 0 additions & 23 deletions
23
docs/system-admin-guide/system-settings/project-system-settings/README.md
This file was deleted.
Oops, something went wrong.
Binary file removed
BIN
-19.4 KB
...admin-guide/system-settings/project-system-settings/image-20211209165901453.png
Binary file not shown.
Binary file removed
BIN
-17.7 KB
...admin-guide/system-settings/project-system-settings/image-20211209170238546.png
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+36.2 KB
(280%)
docs/user-guide/project-overview/Overview-add-widget-1573564870548.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.