diff --git a/docs/development/contribution-documentation/documentation-style-guide/README.md b/docs/development/contribution-documentation/documentation-style-guide/README.md index 30c5a6e11757..eb8adf3c7205 100644 --- a/docs/development/contribution-documentation/documentation-style-guide/README.md +++ b/docs/development/contribution-documentation/documentation-style-guide/README.md @@ -111,7 +111,7 @@ The OpenProject documentation should be as clear and easy to understand as possi - Write in US English with US grammar. - +We aim to use fair language on our language and documentation and choose gender-neutral terms whenever possible. If this is not possible due to the language, e.g. German, we use : to be as inclusive as possible. Please refer to the [fair language guide](../../translate-openproject/fair-language//) for more specific instructions. ## Capitalization diff --git a/docs/getting-started/my-account/1572879640187.png b/docs/getting-started/my-account/1572879640187.png deleted file mode 100644 index 27e1d816b436..000000000000 Binary files a/docs/getting-started/my-account/1572879640187.png and /dev/null differ diff --git a/docs/getting-started/my-account/README.md b/docs/getting-started/my-account/README.md index f25bee96505d..78dd76e183e7 100644 --- a/docs/getting-started/my-account/README.md +++ b/docs/getting-started/my-account/README.md @@ -8,19 +8,22 @@ keywords: my account, account settings, change language # My account -Change your personal settings in My account. Here you can adapt, e.g. the language, edit notifications, or add an avatar. +Change your personal settings in My account. Here you can adapt, e.g. the language, edit notifications, or add an avatar. Moreover you can manage access tokens and sessions. -| Topic | Content | -|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| -| [Open My account settings](#open-my-account-settings) | How to open your personal settings in OpenProject | -| [Change password](#change-password) | How to change my password | -| [Edit your user information](#edit-your-user-information) | How to change the name or email address in OpenProject | +| Topic | Content | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| | | +| [Open My account settings](#open-my-account-settings) | How to open your personal settings in OpenProject | +| [Edit your user information](#edit-your-user-information) | How to change the name or email address in OpenProject | | [Profile settings: change your language, time zone or display of comments](#profile-settings) | How to change the language, time zone or display of comments in OpenProject | -| [Two-factor authentication](#two-factor-authentication) | How to set up a two-factor authentication | -| [Notifications settings](#notifications-settings) | How to change in-app notifications in OpenProject | -| [Email reminders](#email-reminders) | How to change email reminders sent by OpenProject | -| [Set an Avatar](#set-an-avatar) | How to set an avatar in OpenProject and change the profile picture | -| [Delete account](#delete-account) | How to delete my own account | +| [Change password](#change-password) | How to change my password | +| [Two-factor authentication](#two-factor-authentication) | How to set up a two-factor authentication | +| [Access tokens](#access-tokens) | How to set up access tokens in OpenProject | +| [Session management](#session-management) | How to manage your OpenProject sessions | +| [Notifications settings](#notifications-settings) | How to change in-app notifications in OpenProject | +| [Email reminders](#email-reminders) | How to change email reminders sent by OpenProject | +| [Set an Avatar](#set-an-avatar) | How to set an avatar in OpenProject and change the profile picture | +| [Delete account](#delete-account) | How to delete my own account | ## Open My account settings @@ -28,37 +31,25 @@ To open your personal settings in OpenProject, click on your user icon in the to Choose **My account**. -![my account profil information](my-account-profil.png) - -## Change password - -In order to reset your password, navigate to the My account section and choose **Change password** in the menu. - -Enter your current password. - -Enter your new password and confirm it a second time. - -Press the blue **Save** button in order to confirm the password changes. - -![my account change password](my-account-change-password.png) - -> **Note**: You cannot reset your Google password in OpenProject. If you authenticate with a Google/Gmail account, please go to your Google account administration in order to change your password. +![my account profil information](openproject_open_my_account_page.png) ## Edit your user information +To change your email address or your name, navigate to **Profile** on the right side menu of **My account** page. -To change your email address or your name, navigate to the **Profile** page in the menu of your My account settings. +Here you can update the information and **save** your changes. + +![openproject_my_account_profile](openproject_my_account_profile.png) -Here you can adapt the information and **save** your changes with the blue button. ## Profile settings -Within the My account settings you can change the language of OpenProject, adapt the time zone and change the order how comments are displayed in the Activity list for work packages. +Within the **Settings** on **My Account** page you can change the language of OpenProject, adapt the time zone and change the order in which comments are displayed in the **Activity list** for work packages. Also, you can activate a **warning if you are leaving a work package with unsaved changes**. Additionally, you can activate to **auto-hide success notifications** from the system. This (only) means that the green pop-up success notifications will be removed automatically after five seconds. -![my account settings](profile-settings.png) +![OpenProject_my_account_page](openproject_my_account_page.png) ### Change your language @@ -68,7 +59,7 @@ Here you can choose between multiple languages. ![my account change language of user](my-account-change-language-of-user.png) -OpenProject is translated to more than 30 languages, like German, Chinese, French, Italian, Korean, Latvian, Lithuanian, Polish, Portuguese, Russian, Spanish, Turkish and many more. If you do not see your preferred language in the My account settings, the language needs to be activated by your system administrator in the [system's settings](../../system-admin-guide/system-settings/languages). +OpenProject is translated to more than 30 languages, like German, Chinese, French, Italian, Korean, Latvian, Lithuanian, Polish, Portuguese, Russian, Spanish, Turkish and many more. If you do not see your preferred language in the My account settings, the language needs to be activated by your system administrator in the [system's settings](../../system-admin-guide/system-settings/display-settings). Pressing the blue **Save** button will save your changes. @@ -78,8 +69,6 @@ If you want to help us to add further languages or to add the translations in yo You can choose a time zone in which you work and how the comments and changes will be saved. -![my account change time zone](my-account-change-time-zone.png) - Pressing the blue **Save** button will save your changes. ### Change the order to display comments @@ -88,26 +77,36 @@ You can select the order of the comments (for example of the comments for a work If you choose newest first the latest comment will appear on top in the Activity list. -![my account settings comments](order-to-display-comments.png) - ### Backlogs settings There are two personal settings available for the [Backlogs module](../../user-guide/backlogs-scrum/): **Task color**: Here you can enter the color in which your tasks on the task board (on the Backlogs page) are displayed. Tasks on the task board are color-coded based on who they are assigned to. Every user has a default color assigned but if you prefer a different color, you can change it. **Show versions folded**: When you navigate to the "Backlogs" module in a project, the available versions (e.g. Product backlog, Sprints) are displayed. By default they are expanded, i.e. all work packages included in those versions are shown right away. If you have a large number of versions that are shown on the "Backlogs" page, you may opt to collapse them by default. This way you see all the versions on a page and can then choose to expand those versions for which you want to see details. +## Change password + +In order to reset your password, navigate to **My account** and choose **Change password** in the menu. + +![my account change password](openproject_my_account_change_password.png) + +Enter your current password. + +Enter your new password and confirm it a second time. + +Press the blue **Save** button in order to confirm the password changes. + +> **Note**: You cannot reset your Google password in OpenProject. If you authenticate with a Google/Gmail account, please go to your Google account administration in order to change your password. + ## Two-factor authentication In order to activate the two-factor authentication for your OpenProject installation, navigate to your **My account** and choose the **Two-factor authentication** in the menu. -![two factor authentication](two-factor-authentication.png) +![Openproject_my_account_two_factor_authentication](openproject_my_account_two_factor_authentication.png) In order to register a new device for two-factor authentication, click the green button to add a **new 2FA device**. To receive the second factor, you can use an authentication app on your mobile phone, such as Google Authenticator or Authy. You have to enter the code that is displayed in the authentication app to your login. -![app-based-authentication](app-based-authentication.png) - ### Backup codes If you are unable to access your two-factor devices, you can use a backup code to regain access to your account. Use the grey button **Generate backup codes** to generate a new set of backup codes. @@ -122,13 +121,67 @@ Click the grey **Register device** button to register an authentication app. Ope Click the blue **Continue** button to finish the registration. -![register authentication app](1572879640187.png) +![openproject_my_account_authenticator_app](openproject_my_account_authenticator_app.png) + +## Access tokens +To view and manage your OpenProject access tokens navigate to **My account** and choose **Access tokens** from the menu. +Access tokens allow you to grant external applications access to resources in OpenProject. + +![openproject_my_account_access_tokens](openproject_my_account_access_tokens.png) + +### API +API tokens allow third-party applications to communicate with this OpenProject instance via REST APIs. If you have not yet created an API token, this list will be empty. You may need admin privileges to be able to create an API. +You can enable an API token under [*Administration -> API and webhooks*](../../system-admin-guide/api-and-webhooks/). Please not that you can only create a single API token. +### iCalendar +iCalendar tokens allow users to subscribe to OpenProject calendars and view up-to-date work package information from external clients. +This list will be empty if you have not yet subscribed to any calendars. Once you [subscribe to a calendar] (LINK TO ICAL DOCUMENTATION), a list of all the calendars that you have subscribed to will appear here. The name of the calendar is clickable and will lead you directly to the respective calendar in OpenProject. +![OpenProject calendar list under my account](openproject_my_account_access_tokens_calendar_list.png) + +You can delete an entry in the iCalendar list by clicking on the **Delete** icon. This will trigger a warning message asking you to confirm the decision to delete. By deleting this token you will no longer have access to OpenProject information in all the linked clients using this token. + +![OpenProject delete calendar in My Account](openproject_my_account_access_tokens_delete_calendar.png) + +You will then see a message informing you that the the token und the iCal URL are now invalid. + +![OpenProject calendar access token is invalid](openproject_my_account_access_tokens_calendar_invalid.png) + +### OAUTH + +OAuth tokens allow third-party applications to connect with this OpenProject instance, for example Nextcloud (see [here](https://www.openproject.org/docs/user-guide/nextcloud-integration/) how to set up Nextcloud integration. OAuth tokens can be created under [*Administration-> Authentication*](https://www.openproject.org/docs/system-admin-guide/authentication/). + +If no third-party application integration has been activated yet, this list will be empty. Please contact your administrator to help you set it up. Once an integration has been set up, you will see the details here and will be able to delete any OAuth tokens by clicking on the **Delete** icon. + +![OpenProject OAuth tokens under My Account](openproject_my_account_access_tokens_oauth.png) + + + +### RSS + +RSS tokens allow users to keep up with the latest changes in this OpenProject instance via an external RSS reader. You can only have one active RSS token. + +Create by clicking the **+RSS token** button. This will create your token and trigger a message showing you the access token. + +> **Note**: You will only be able to see the RSS access token once, directly after you create it. Make sure to copy it. + +![OpenProject RSS token](openproject_my_account_access_tokens_rss.png) + +## Sessions management + +To view and manage your OpenProject sessions navigate to **My account** and choose **Sessions management** from the menu. + +![openproject_my_account_sessions_management](openproject_my_account_sessions_management.png) + +Here you can see all of your sessions. If for example you are logged into OpenProject from different browsers or devices, all will be shown in the list. Current session is the one you are currently using. You can terminate the sessions that are no longer in use. Inactive sessions will be removed from the list after 7 days (depending on the authentication settings they may become invalid earlier). + +> **Note**: Closing a browser does not necessarily terminate the session. It might still be displayed in the list and will be reactivated if you open the browser. This depends on both your browser's and the OpenProject instance's settings. ## Notifications settings -**My account > Notification settings** +To configure the notification settings which you receive from the system, navigate to **My account** and choose **Notifications settings** in the menu. + +![openproject_my_account_notifications](openproject_my_account_notifications.png) In-app notifications can be configured and customized various ways. For a detailed guide, [click here](../../user-guide/notifications/notification-settings/). @@ -136,18 +189,16 @@ Please also see our detailed [in-app notifications](../../user-guide/notificatio ## Email reminders -**My account > Email reminders** - To configure the email reminders which you receive from the system, navigate to **My account** and choose **Email reminders** in the menu. Your system administrator can also set them for you or change the global default settings. +![openproject_my_account_email_reminders](openproject_my_account_email_reminders.png) + You can choose between several email reminders. Default: Enable daily email reminders: 2am, Monday - Friday. You can choose to receive emails immediately, or only on certain days and times, temporarily pause reminder emails, or opt for no reminders at all. -![set email reminders](email-reminders.png) - You can also opt-in to receive **email alerts for other items (that are not work packages)** whenever one of your project members: - **News added** - ...adds or updates news in the [News Page](../../user-guide/news/) @@ -161,7 +212,9 @@ You can also opt-in to receive **email alerts for other items (that are not work ## Set an avatar -To change your profile picture in OpenProject you can set an avatar in your My account settings. Navigate to **Avatar** in the menu. +To change your profile picture in OpenProject you can set an avatar in your **My account** settings. Navigate to **Avatar** in the menu. + +![openproject_my_account_avatar](openproject_my_account_avatar.png) OpenProject uses Gravatar as default profile image. It displays a preview of your avatar. @@ -169,16 +222,14 @@ Also, you can upload a **Custom Avatar** by choosing a Avatar to be uploaded fro > **Note**: The optimum size to upload a new profile picture is 128 by 128 pixel. Larger files will be cropped. -![change your avatar](change-avatar.png) - # Delete account You can delete your own account in **My account**. -If you cannot see the entry **Delete account** in the **My account** side menu, make sure the option "Users allowed to delete their account" is [activated in the administration](../../system-admin-guide/users-permissions/settings/#user-deletion). - To delete your account, select **Delete account** from the side menu and enter your login to confirm the deletion. -![delete your account](delete-account.png) +![openproject_my_account_delete_account](openproject_my_account_delete_account.png) > **Important**: Deleting a user account is permanent and cannot be reversed. + +If you cannot see the entry **Delete account** in the **My account** side menu, make sure the option "Users allowed to delete their account" is [activated in the administration](../../system-admin-guide/users-permissions/settings/#user-deletion). diff --git a/docs/getting-started/my-account/app-based-authentication.png b/docs/getting-started/my-account/app-based-authentication.png deleted file mode 100644 index b177bd253728..000000000000 Binary files a/docs/getting-started/my-account/app-based-authentication.png and /dev/null differ diff --git a/docs/getting-started/my-account/change-avatar.png b/docs/getting-started/my-account/change-avatar.png deleted file mode 100644 index d1e023f77700..000000000000 Binary files a/docs/getting-started/my-account/change-avatar.png and /dev/null differ diff --git a/docs/getting-started/my-account/delete-account.png b/docs/getting-started/my-account/delete-account.png deleted file mode 100644 index 7862cb66375d..000000000000 Binary files a/docs/getting-started/my-account/delete-account.png and /dev/null differ diff --git a/docs/getting-started/my-account/email-reminders.png b/docs/getting-started/my-account/email-reminders.png deleted file mode 100644 index e979a1fd8e6d..000000000000 Binary files a/docs/getting-started/my-account/email-reminders.png and /dev/null differ diff --git a/docs/getting-started/my-account/my-account-change-language-of-user.png b/docs/getting-started/my-account/my-account-change-language-of-user.png deleted file mode 100644 index f972b50b243c..000000000000 Binary files a/docs/getting-started/my-account/my-account-change-language-of-user.png and /dev/null differ diff --git a/docs/getting-started/my-account/my-account-change-password.png b/docs/getting-started/my-account/my-account-change-password.png deleted file mode 100644 index 8dc8fdddfa0d..000000000000 Binary files a/docs/getting-started/my-account/my-account-change-password.png and /dev/null differ diff --git a/docs/getting-started/my-account/my-account-change-time-zone.png b/docs/getting-started/my-account/my-account-change-time-zone.png deleted file mode 100644 index e4f136773113..000000000000 Binary files a/docs/getting-started/my-account/my-account-change-time-zone.png and /dev/null differ diff --git a/docs/getting-started/my-account/my-account-profil.png b/docs/getting-started/my-account/my-account-profil.png deleted file mode 100644 index 444f759ba813..000000000000 Binary files a/docs/getting-started/my-account/my-account-profil.png and /dev/null differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens.png b/docs/getting-started/my-account/openproject_my_account_access_tokens.png new file mode 100644 index 000000000000..f64353c8c807 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_invalid.png b/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_invalid.png new file mode 100644 index 000000000000..d6197a63ce70 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_invalid.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_list.png b/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_list.png new file mode 100644 index 000000000000..773a756716b2 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens_calendar_list.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens_delete_calendar.png b/docs/getting-started/my-account/openproject_my_account_access_tokens_delete_calendar.png new file mode 100644 index 000000000000..cee7bc19b44d Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens_delete_calendar.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens_oauth.png b/docs/getting-started/my-account/openproject_my_account_access_tokens_oauth.png new file mode 100644 index 000000000000..e8fb25dce062 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens_oauth.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_access_tokens_rss.png b/docs/getting-started/my-account/openproject_my_account_access_tokens_rss.png new file mode 100644 index 000000000000..8b4f63e8cbfd Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_access_tokens_rss.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_authenticator_app.png b/docs/getting-started/my-account/openproject_my_account_authenticator_app.png new file mode 100644 index 000000000000..b5e143e7a24b Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_authenticator_app.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_avatar.png b/docs/getting-started/my-account/openproject_my_account_avatar.png new file mode 100644 index 000000000000..15a404e2d69f Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_avatar.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_change_password.png b/docs/getting-started/my-account/openproject_my_account_change_password.png new file mode 100644 index 000000000000..1e2e9473eec0 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_change_password.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_delete_account.png b/docs/getting-started/my-account/openproject_my_account_delete_account.png new file mode 100644 index 000000000000..5988b93787a5 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_delete_account.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_email_reminders.png b/docs/getting-started/my-account/openproject_my_account_email_reminders.png new file mode 100644 index 000000000000..5e076b594f6e Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_email_reminders.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_notifications.png b/docs/getting-started/my-account/openproject_my_account_notifications.png new file mode 100644 index 000000000000..3844a6b1366c Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_notifications.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_page.png b/docs/getting-started/my-account/openproject_my_account_page.png new file mode 100644 index 000000000000..690c6ef6a3c2 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_page.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_profile.png b/docs/getting-started/my-account/openproject_my_account_profile.png new file mode 100644 index 000000000000..b41bacaef5f2 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_profile.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_sessions_management.png b/docs/getting-started/my-account/openproject_my_account_sessions_management.png new file mode 100644 index 000000000000..2d489833dde7 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_sessions_management.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_two_factor_authentication.png b/docs/getting-started/my-account/openproject_my_account_two_factor_authentication.png new file mode 100644 index 000000000000..295a169397c1 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_two_factor_authentication.png differ diff --git a/docs/getting-started/my-account/openproject_my_account_two_factor_register_device.png b/docs/getting-started/my-account/openproject_my_account_two_factor_register_device.png new file mode 100644 index 000000000000..a2c82ee32529 Binary files /dev/null and b/docs/getting-started/my-account/openproject_my_account_two_factor_register_device.png differ diff --git a/docs/getting-started/my-account/openproject_open_my_account_page.png b/docs/getting-started/my-account/openproject_open_my_account_page.png new file mode 100644 index 000000000000..41c91e44790f Binary files /dev/null and b/docs/getting-started/my-account/openproject_open_my_account_page.png differ diff --git a/docs/getting-started/my-account/order-to-display-comments.png b/docs/getting-started/my-account/order-to-display-comments.png deleted file mode 100644 index d821ce53e881..000000000000 Binary files a/docs/getting-started/my-account/order-to-display-comments.png and /dev/null differ diff --git a/docs/getting-started/my-account/profile-settings.png b/docs/getting-started/my-account/profile-settings.png deleted file mode 100644 index 303556fa1dd6..000000000000 Binary files a/docs/getting-started/my-account/profile-settings.png and /dev/null differ diff --git a/docs/getting-started/my-account/two-factor-authentication.png b/docs/getting-started/my-account/two-factor-authentication.png deleted file mode 100644 index 16cf2d20e7cc..000000000000 Binary files a/docs/getting-started/my-account/two-factor-authentication.png and /dev/null differ diff --git a/docs/getting-started/my-activity/README.md b/docs/getting-started/my-activity/README.md new file mode 100644 index 000000000000..c4f999ad7817 --- /dev/null +++ b/docs/getting-started/my-activity/README.md @@ -0,0 +1,22 @@ +--- +sidebar_navigation: + title: My Activity + priority: 200 +description: My Activity in OpenProject - your latest actions +keywords: my activity, personal changes, dashboard +--- + +# My Activity + +**My Activity** gives you an overview of all your latest actions and projects you are involved in. + +You can open your **My Activity** page by clicking on your user avatar in the upper right corner and then selecting **My Activity** from the dropdown menu. + +![OpenProject navigate to My Activity Page](openproject_select_my_actvity.png) + +You will see two lists by default. **Projects** will show all projects you are a member of. **Activity** will show all of your activities that are being recorded in OpenProject. + +![Openproject_my_activity_page](openproject_my_activity_overview.png) + + + diff --git a/docs/getting-started/my-activity/openproject_my_activity_overview.png b/docs/getting-started/my-activity/openproject_my_activity_overview.png new file mode 100644 index 000000000000..6c434de1b71b Binary files /dev/null and b/docs/getting-started/my-activity/openproject_my_activity_overview.png differ diff --git a/docs/getting-started/my-activity/openproject_select_my_actvity.png b/docs/getting-started/my-activity/openproject_select_my_actvity.png new file mode 100644 index 000000000000..ec6d54855741 Binary files /dev/null and b/docs/getting-started/my-activity/openproject_select_my_actvity.png differ diff --git a/docs/getting-started/my-page/navigate-to-my-page.png b/docs/getting-started/my-page/navigate-to-my-page.png index 30b48274cd3e..3a2c95e6ef74 100644 Binary files a/docs/getting-started/my-page/navigate-to-my-page.png and b/docs/getting-started/my-page/navigate-to-my-page.png differ diff --git a/docs/user-guide/notifications/README.md b/docs/user-guide/notifications/README.md index a35b7b77db36..51bf0ff59b17 100644 --- a/docs/user-guide/notifications/README.md +++ b/docs/user-guide/notifications/README.md @@ -37,7 +37,7 @@ The work packages are listed in order of freshness. The work packages on top of ## Manage notifications -Click on a notification to open the Activity tab of this work package in split screen. The Activity tab will auto-scroll to the last event that generated a notification. +Click on a notification to open the Activity tab of this work package in split screen. If you double click on a notification, it will open the full view of a work package. The Activity tab will auto-scroll to the last event that generated a notification. > **Info:** Not all work package activity generate notifications. For example, if you received a notification because you were mentioned, there might be other activities on that work package after that, even though the *Activity* tab will auto-scroll to highlight the mention when you click on the notification, since the mention was originally what triggered the notification. diff --git a/docs/user-guide/search/README.md b/docs/user-guide/search/README.md index 66cdaa62281b..0d097fdd24d7 100644 --- a/docs/user-guide/search/README.md +++ b/docs/user-guide/search/README.md @@ -22,13 +22,13 @@ Searching for e.g. "big cat" will also return work packages with the description To access the more detailed, advanced search, choose one of the options shown below the search bar with your arrow keys (then press the Enter key) or by using the mouse. -![advanced-search-options](image-20210412204814858.png) +![advanced-search-options](openproject_search_options.png) If you do not have a project open at the moment, the first two options won't be shown. -Now, you can find the results for your search term from different categories/parts of OpenProject. In the work packages section you can click on **Advanced filter** to access additional filter options (the same as in other work package tables). +Now, you can find the results for your search term from different categories/parts of OpenProject. In the work packages section you can click on **Advanced filter** to access additional filter options. It will allow using same search criteria as for the work package tables. -![search-result-categories](image-20210412205730857.png) +![search-result-categories](openproject_search_result_categories.png) Please note: It is not possible to find content from archived projects. You will have to un-archive them first on the [global projects overview page](../projects/#projects-list). @@ -38,3 +38,8 @@ The search bar of OpenProject is configured to allow a full text search. This me The title and the description of a work package can also be found by [filtering by text](../work-packages/work-package-table-configuration/#filter-by-text). Aside from full-text search, you can [search work packages based on their attached file name or even within the content of an attachment](../work-packages/work-package-table-configuration/#filter-for-attachment-file-name-and-content). + +## Recently viewed work packages +Since [version 13.0](https://www.openproject.org/docs/release-notes/13-0-0/), clicking on the search bar will immediately show your most recently viewed work packages, before you even start typing. + +![OpenProject recent work packages](openproject_search_recently_viewed.png) \ No newline at end of file diff --git a/docs/user-guide/search/openproject_search_options.png b/docs/user-guide/search/openproject_search_options.png new file mode 100644 index 000000000000..c205cee4c364 Binary files /dev/null and b/docs/user-guide/search/openproject_search_options.png differ diff --git a/docs/user-guide/search/openproject_search_recently_viewed.png b/docs/user-guide/search/openproject_search_recently_viewed.png new file mode 100644 index 000000000000..1950a6d36dab Binary files /dev/null and b/docs/user-guide/search/openproject_search_recently_viewed.png differ diff --git a/docs/user-guide/search/openproject_search_result_categories.png b/docs/user-guide/search/openproject_search_result_categories.png new file mode 100644 index 000000000000..427644a4af3a Binary files /dev/null and b/docs/user-guide/search/openproject_search_result_categories.png differ diff --git a/docs/user-guide/search/search-bar-in-navigation-bar.png b/docs/user-guide/search/search-bar-in-navigation-bar.png index 2d30bd987643..5c80a312b3ed 100644 Binary files a/docs/user-guide/search/search-bar-in-navigation-bar.png and b/docs/user-guide/search/search-bar-in-navigation-bar.png differ diff --git a/docs/user-guide/wiki/1568194001092.png b/docs/user-guide/wiki/1568194001092.png deleted file mode 100644 index c63aa1099ce4..000000000000 Binary files a/docs/user-guide/wiki/1568194001092.png and /dev/null differ diff --git a/docs/user-guide/wiki/README.md b/docs/user-guide/wiki/README.md index 6fd543725faa..93c17125febd 100644 --- a/docs/user-guide/wiki/README.md +++ b/docs/user-guide/wiki/README.md @@ -33,7 +33,7 @@ The text editor in OpenProject supports basic text styles, such as bold and ital Simply type in your text in the input field, highlight a text and select the formatting via the toolbar on top. -![wiki](1568194001092.png) +![openproject_user_guide_wiki](openproject_user_guide_wiki.png) ### Linebreaks @@ -57,6 +57,12 @@ As CKEditor5 currently does not provide support for code blocks, OpenProject can The GFM extension of the CommonMark specs adds a definition for table syntax which the CKEditor build of OpenProject supports. This definition requires all tables to have a heading row. For tables created with CKEditor without heading rows, a HTML table is output instead. This matches the behavior of, e.g., GitHub. +### Emojis +Starting with OpenProject 13.0 you can add emojis to all text editors. Type a colon and a letter, e.g. **:a** into the wiki editor and get a suggested list of emojis you can use. + +![openproject_user_guide_wiki_emoji](openproject_user_guide_wiki_emoji.png) + + ### Autoformatting CKEditor5 allows certain CommonMark-like autoformatting keyboard strokes: diff --git a/docs/user-guide/wiki/openproject_user_guide_wiki.png b/docs/user-guide/wiki/openproject_user_guide_wiki.png new file mode 100644 index 000000000000..5854a7a58390 Binary files /dev/null and b/docs/user-guide/wiki/openproject_user_guide_wiki.png differ diff --git a/docs/user-guide/wiki/openproject_user_guide_wiki_emoji.png b/docs/user-guide/wiki/openproject_user_guide_wiki_emoji.png new file mode 100644 index 000000000000..d52bd7950ec4 Binary files /dev/null and b/docs/user-guide/wiki/openproject_user_guide_wiki_emoji.png differ diff --git a/docs/user-guide/work-packages/copy-move-delete/README.md b/docs/user-guide/work-packages/copy-move-delete/README.md index 0b049160148c..9fb8e6034d5f 100644 --- a/docs/user-guide/work-packages/copy-move-delete/README.md +++ b/docs/user-guide/work-packages/copy-move-delete/README.md @@ -8,15 +8,17 @@ keywords: copy work package, delete work package, move work package # Copy, change project or delete a work package -If you click with the right mouse button in the line of the work package, a list with different editing options for the selected work package opens. Here you can copy the work package, delete it and move it to another project. You can access these features from the work package table or from within a work package. +If you right-click in a work package table, editing options will be displayed. Here, you can change project, copy the work package, or copy its URL to the clipboard, delete it or move it to another project. -You can also dit a work package using the three dots at the far right of a row to access the menu. +![change copy delete work package](openproject_user_guide_copy_move_delete_wptableview.png) -![change copy delete work package](change-copy-delete-work-package.png) +You can also access these features by using the three dots at the far right of a row to access the menu. -Alternatively, open the work packages details view, click on **More functions** (the three dots at the top right of the work package details) and select the respective menu item. +![OpenProject copy move delete work package](openproject_user_guide_copy_move_delete_threedotsmenu.png) -![User guide copy change project delete](User-guide-copy-change-project-delete-4071022.png) +Alternatively, open the work packages details view by double clicking the respective row, click on **More functions** (the three dots at the top right of the work package details) and select the respective menu item. + +![User guide copy change project delete](openproject_user_guide_copy_move_delete_detailed_view.png) To copy, move or delete multiple work packages at once please refer to the documentation for [bulk edit](../edit-work-package/#bulk-edit-work-packages). @@ -24,7 +26,11 @@ To copy, move or delete multiple work packages at once please refer to the docum When copying a work package, a work package form with the pre-set values of the original work package is shown. -Copying a work package allows to easily create and adjust new work packages based on existing one’s. +Copying a work package allows to easily create and adjust new work packages based on existing one’s. + +## Copy link to clipboard + +This option copies a short link to the work package to your clipboard so you can quickly paste it elsewhere. It can also be useful when you want to quickly copy links to multiple work packages without having to open the detailed view of each one. ## Move a work package to a different project. diff --git a/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_detailed_view.png b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_detailed_view.png new file mode 100644 index 000000000000..4a60c577a0f0 Binary files /dev/null and b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_detailed_view.png differ diff --git a/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_threedotsmenu.png b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_threedotsmenu.png new file mode 100644 index 000000000000..494a426f2f70 Binary files /dev/null and b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_threedotsmenu.png differ diff --git a/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_wptableview.png b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_wptableview.png new file mode 100644 index 000000000000..ed8481c9bc43 Binary files /dev/null and b/docs/user-guide/work-packages/copy-move-delete/openproject_user_guide_copy_move_delete_wptableview.png differ diff --git a/docs/user-guide/work-packages/create-work-package/README.md b/docs/user-guide/work-packages/create-work-package/README.md index cb3a39e727c2..9c05e9cd189b 100644 --- a/docs/user-guide/work-packages/create-work-package/README.md +++ b/docs/user-guide/work-packages/create-work-package/README.md @@ -54,6 +54,10 @@ Click the green **Save** button. +Starting with OpenProject 13.0 you can add emojis to all text editors, including the work package description. Type a colon and a letter, e.g. **:a** into the text editor and get a suggested list of emojis you can use. + +![openproject_user_guide_wp_description_emojis](openproject_user_guide_wp_description_emojis.png) + To find out **how to create a child Work package** please click [here](../work-package-relations-hierarchies/#adding-a-child-work-package). diff --git a/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wiki_emoji.png b/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wiki_emoji.png new file mode 100644 index 000000000000..d52bd7950ec4 Binary files /dev/null and b/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wiki_emoji.png differ diff --git a/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wp_description_emojis.png b/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wp_description_emojis.png new file mode 100644 index 000000000000..e5e13fa718b1 Binary files /dev/null and b/docs/user-guide/work-packages/create-work-package/openproject_user_guide_wp_description_emojis.png differ diff --git a/docs/user-guide/work-packages/edit-work-package/README.md b/docs/user-guide/work-packages/edit-work-package/README.md index ce4c7ba774b3..e2872a4571aa 100644 --- a/docs/user-guide/work-packages/edit-work-package/README.md +++ b/docs/user-guide/work-packages/edit-work-package/README.md @@ -69,6 +69,11 @@ You can mention and notify team members via [@notification](../../notifications/ ![comment-work-packages](comment-work-packages.png) +### Emojis +Starting with OpenProject 13.0 you can add emojis to all text editors. Type a colon and a letter, e.g. **:a** into the wiki editor and get a suggested list of emojis you can use. + +![openproject_user_guide_wp_comment_emojis](openproject_user_guide_wp_comment_emojis.png) + ## Watchers ### How to add watchers to a work package diff --git a/docs/user-guide/work-packages/edit-work-package/openproject_user_guide_wp_comment_emojis.png b/docs/user-guide/work-packages/edit-work-package/openproject_user_guide_wp_comment_emojis.png new file mode 100644 index 000000000000..992e56d7ccf8 Binary files /dev/null and b/docs/user-guide/work-packages/edit-work-package/openproject_user_guide_wp_comment_emojis.png differ