Skip to content

Commit

Permalink
Improve project lists documentation (#17511)
Browse files Browse the repository at this point in the history
  • Loading branch information
MayaBerd authored Dec 20, 2024
1 parent f583812 commit b38fa24
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
19 changes: 13 additions & 6 deletions docs/user-guide/projects/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ OpenProject, for example, uses the projects to structure the different modules/p

![project hierarchy select project](image-20220728200830893.png)

**Note**: You have to be a [member](../members/#add-members) of a project in order to see the project and to work in a project.
>[!NOTE]
>You have to be a [member](../members/#add-members) of a project in order to see the project and to work in a project.

## Project Settings

Expand All @@ -85,7 +87,8 @@ You can specify further advanced settings for your project. Navigate to your pro

- You see the default project **Identifier**. The identifier will be shown in the URL.

**Note**: Changing the project identifier while the project is already being worked on can have major effects and is therefore not recommended. For example, repositories may not be loaded correctly and deep links may no longer work (since the project URL changes when the project identifier is changed).
> [!NOTE]
> Changing the project identifier while the project is already being worked on can have major effects and is therefore not recommended. For example, repositories may not be loaded correctly and deep links may no longer work (since the project URL changes when the project identifier is changed).
- You can set a project to **Public**. This means it can be accessed without signing in to OpenProject.
- Click the green **Save** button to save your changes.
Expand Down Expand Up @@ -123,7 +126,8 @@ You can copy existing [boards](../agile-boards) (apart from the Subproject board

![project settings information copy project copy options](project-settigns-copy-project.png)

> **!!Attention!!** - **Budgets** cannot be copied, so they must be removed from the work package table beforehand. Alternatively, you can delete them in the Budget module and thus delete them from the work packages as well.
> [!IMPORTANT]
> **Budgets** cannot be copied, so they must be removed from the work package table beforehand. Alternatively, you can delete them in the Budget module and thus delete them from the work packages as well.
For further configuration open the **Advanced settings**. Here you can specify (among other things) the project's URL (identifier), its visibility and status. Furthermore you can set values for custom fields.

Expand All @@ -133,7 +137,8 @@ Under the **Copy options** section you can select what additional project data a

![Copy options when copying a project in OpenProject](project-settings-copy-project-copy-options.png)

**Note**: the File storages options only apply if the template project had [OneDrive/SharePoint](../../system-admin-guide/integrations/one-drive) with automatically managed folders activated.
> [!NOTE]
> The File storages options only apply if the template project had [OneDrive/SharePoint](../../system-admin-guide/integrations/one-drive) with automatically managed folders activated.
If you select the **File Storages: Project folders** option, both the storage and the storage folders are copied into the new project if automatically managed project folders were selected for the original file storage. For storages with manually managed project folders setup the copied storage will be referencing the same folder as the original project.

Expand All @@ -147,7 +152,8 @@ Once you are done, click the green **Save** button.

In order to archive a project, navigate to the [project settings](project-settings), and click the **Archive project** button.

> **Note**: This option is always available to instance and project administrators. It can also be activated for specific roles by enabling the _Archive project_ permission for that role via the [Roles and permissions](../../system-admin-guide/users-permissions/roles-permissions/) page in the administrator settings.
> [!NOTE]
> This option is always available to instance and project administrators. It can also be activated for specific roles by enabling the _Archive project_ permission for that role via the [Roles and permissions](../../system-admin-guide/users-permissions/roles-permissions/) page in the administrator settings.
![project settings archive project](project-settings-archive-project.png)

Expand All @@ -165,4 +171,5 @@ If you want to delete a project, navigate to the [Project settings](project-sett

You can also delete a project via the [projects overview list](./project-lists/).

**Note**: Deleting projects is only available for System administrators.
> [!NOTE]
> Deleting projects is only available for System administrators.
11 changes: 7 additions & 4 deletions docs/user-guide/projects/project-lists/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ There are several ways to get an overview of all your projects. You can press th

![project lists button](Project-list-button.png)

> [!TIP]
>If you have already selected a project, the **x** icon next to that project will navigate you away from that selected project.
![Close an already selected project](openproject_user_guide_project_project_list.png)

Alternatively, you can use the [**Global modules menu**](../../home/global-modules/#projects) and select *Projects*. You can access that menu either on the left side of the OpenProject application homepage or by using the grid menu icon in the top right corner.

![Select all projects from the global modules menu in OpenProject](view_all_projects_options.png)
Expand Down Expand Up @@ -97,7 +102,8 @@ Click **Apply** to see the changes.

If the list that you were adjusting is a private list, you will then be able to save the changes to that list by clicking the *Save* link. Alternatively you can click the *More* icon and select the *Save as* option from the dropdown menu that will open and save it under a different name.

**Note:** The *Save as* option in the *More* dropdown menu is always available. The *Save* action will not be visible if you are working with a static list, which can not be modified.
> [!NOTE]
> The *Save as* option in the *More* dropdown menu is always available. The *Save* action will not be visible if you are working with a static list, which can not be modified.
![Save a project list view in OpenProject](save-link-project-list.png)

Expand Down Expand Up @@ -190,9 +196,6 @@ In order to work on project lists uninterrupted, you can use the Zen mode. To ac

![Select zen mode in OpenProject project lists](openproject_project_list_select_zen_mode.png)




## Favorite project lists

You can mark project lists as favorites, both shared and private, but not the static ones. To mark a project list as favorite click the star icon in the top right corner.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b38fa24

Please sign in to comment.