mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Docs/12.0 corrections (#10101)
* Docs/12.0 (#9970) * update locales from crowdin [ci skip] * Create README.md * Upload Images [CI SKIP] Upload Images * Update README.md [ci skip] * Update README.md * Update README.md * Update README.md * Images exchanged Images exchanged - spaces in file name not compatible... * Image corrections [ci skip] * update docs for 12.0 [ci skip] update docs for 12.0 * Update README.md [ci skip] * Update README.md [ci skip] * Update README.md [ci skip] * Update README.md [ci skip] * Update README.md [ci skip] * Changes to notifications * Updates to in-app notifications and settings [ci skip] * updates [ci skip] * updates [ci skip] * update [ci skip] * update [ci skip] * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Updates [ci skip] * Update README.md [ci skip] * Update README.md * Update README.md [ci skip] * Small correction * Adding changes to notifications documentation * Doc Update - System settings [CI SKIP] [#40136] Update system settings in System Admin Guide https://community.openproject.org/work_packages/40136 Doc Update - System settings * @Fweber1331 Doc Update - System settings 2 [CI SKIP] [#40136] Update system settings in System Admin Guide https://community.openproject.org/work_packages/40136 Update to docs/12.0/admin guide/system settings * Resloving merge conflicts Co-authored-by: OpenProject Actions CI <operations+ci@openproject.com> Co-authored-by: birthe <b.lindenthal@openproject.com> * Correction to Sys Admin Guide Docs (#10097) * Correction to Sys Admin Guide Docs [#40136] Update system settings in System Admin Guide https://community.openproject.org/work_packages/40136 * Review and small changes Co-authored-by: birthe <b.lindenthal@openproject.com> Co-authored-by: Fweber1331 <85182737+Fweber1331@users.noreply.github.com> Co-authored-by: OpenProject Actions CI <operations+ci@openproject.com> Co-authored-by: birthe <b.lindenthal@openproject.com>
This commit is contained in:
Andrej Sandorf
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
@@ -17,8 +17,8 @@ Change your personal settings in My account. Here you can adapt, e.g. the langua
|
||||
| [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 |
|
||||
| [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-premium-feature) | How to set up a two-factor authentication |
|
||||
| [Notifications settings](#notifications-settings) | How to change in-app notifications in OpenProject |
|
||||
| [Two-factor authentication](#two-factor-authentication-premium-feature) | 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 |
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
sidebar_navigation:
|
||||
title: Attachments settings
|
||||
priority: 940
|
||||
title: Attachments settings
|
||||
description: Settings for max attachment size and allowed file types
|
||||
robots: index, follow
|
||||
keywords: Attachments Settings
|
||||
|
||||
---
|
||||
|
||||
# Attachments - Max size and allowed file types
|
||||
|
||||
1. Here you can increase or decrease **maximum attachment size** (in kB)
|
||||
|
||||
2. The box next to **Attachment upload whitelist** is an open-entry text box in which some common file formats are pre-populated by default. The file formats in this list are specifically whitelisted or allowed to be attached to work packages.
|
||||
If you wish, you can add additional file formats. Use only one file format entry per line, and keep to the following cadence:
|
||||
|
||||
*****.[**file extension**]
|
||||
|
||||
Example: To add mp3-files to the whitelist, your entry would be "***.mp3**".
|
||||
|
||||
2. Do not forget to **save** your changes.
|
||||
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_navigation:
|
||||
title: System settings
|
||||
priority: 770
|
||||
priority: 920
|
||||
description: System settings in OpenProject.
|
||||
robots: index, follow
|
||||
keywords: system settings
|
||||
@@ -10,16 +10,18 @@ keywords: system settings
|
||||
|
||||
There are various project overarching settings that are referred to as **system settings**. To adapt these system settings, navigate to your user name and select *Administration* -> *System settings*.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
| Topic | Content |
|
||||
| --------------------------------------------------- | :----------------------------------------------------------- |
|
||||
| [General settings](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
|
||||
| [Display settings](display-settings) | How to configure languages, date and time formats, week start, and more? |
|
||||
| [System projects settings](project-system-settings) | How to set default project modules and more? |
|
||||
| [Repositories](repositories) | How to integrate SVN or GIT repositories? |
|
||||
| Topic | Content |
|
||||
| ------------------------------------------- | :----------------------------------------------------------- |
|
||||
| [General settings](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more? |
|
||||
| [Display settings](display-settings) | How to configure languages, date and time formats, week start, and more? |
|
||||
| [Project settings](project-system-settings) | Settings for new projects. |
|
||||
| [Attachments](attachments) | Settings for attachments. |
|
||||
| [API](api-settings) | API settings (enable docs and CORS). |
|
||||
| [Repositories](repositories) | How to integrate SVN or GIT repositories? |
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
---
|
||||
sidebar_navigation:
|
||||
title: API settings
|
||||
priority: 930
|
||||
title: API settings
|
||||
description: Settings for API functionality of OpenProject
|
||||
robots: index, follow
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
@@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_navigation:
|
||||
title: Language and display settings
|
||||
priority: 900
|
||||
priority: 960
|
||||
description: Display settings in OpenProject.
|
||||
robots: index, follow
|
||||
keywords: display settings
|
||||
@@ -13,8 +13,7 @@ You can configure display settings in OpenProject. Under System settings on the
|
||||
## Configure available languages
|
||||
|
||||
Choose the languages which you want to activate for your system. Those languages which you will check will appear in the language settings of the user profiles and can be set for the system.
|
||||
|
||||
|
||||
|
||||
|
||||
At the moment there are more than 30 languages available.
|
||||
<div>
|
||||
@@ -26,17 +25,15 @@ You can [choose your language in your user profile](../../../getting-started/my-
|
||||
|
||||
Change time and date formats in OpenProject and configure the display of journal aggregation.
|
||||
|
||||
- **Week starts on**: Configure what date the week starts (e.g. in the calendar view). Default is based on user's language. You can also choose to start a week always on Monday, Sunday or Saturdays.
|
||||
If you set Week starts on, you must also set the First week in year or will probably get inconsistencies in week numbering in calendars and the gantt chart.
|
||||
- **First week in year contains**: Select the day that needs to be contained in the first week of the year. This value is used together with _Week starts on_ to determine the first week of the year.
|
||||
1. **Week starts on**: Configure what date the week starts (e.g. in the calendar view). Default is `Based on user's language`.
|
||||
You can also choose to start a week always on Monday, Sunday or Saturdays.
|
||||
If you set Week starts on, you must also set the First week in year or will probably get inconsistencies in week numbering in calendars and the Gantt chart.
|
||||
2. **First week in year contains**: Select the day that needs to be contained in the first week of the year. This value is used together with _Week starts on_ to determine the first week of the year.
|
||||
- For European ISO-8601 standard, set Week starts on to `Monday` and First week in year to `Thursday`.
|
||||
- For US and Canada, set Week starts on to `Sunday` and Day of Year to `6`.
|
||||
- If you leave both on `Based on user's language`, the information provided by moment.js will be used: For more information, please also see [this document from moment.js](https://momentjscom.readthedocs.io/en/latest/moment/07-customization/16-dow-doy/).
|
||||
- For more information on the way the first week of the year is computed according to ISO standards, see https://en.wikipedia.org/wiki/ISO_week_date#First_week
|
||||
- **Date format**: default is based on user's language. You can choose various formats to display dates in the system.
|
||||
- **Time format**: default is based on user's language. You can choose various formats to display time in the system.
|
||||
- **Users display format**: default is Firstname Lastname. You can change to various different formats.
|
||||
- **Display journals as aggregated within** will enable you to choose a time to combine journals of this timespan, e.g. for work package notifications. This way if you do several updates at in a short period of time, you will not receive an email notification for each update but only a notification for the chosen period.
|
||||
- Do not forget to **save** your changes.
|
||||
|
||||
|
||||
3. **Date format**: default is based on user's language. You can choose various formats to display dates in the system.
|
||||
4. **Time format**: default is based on user's language. You can choose various formats to display time in the system.
|
||||
5. **Users display format**: default is [First name] [Last name]. You can change to various different formats.
|
||||
6. Do not forget to **save** your changes.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
@@ -12,8 +12,6 @@ You can configure general system settings in OpenProject. Under System settings
|
||||
|
||||
1. **Application title**: This title will be displayed on the [application start page](../../../user-guide/start-page).
|
||||
|
||||
2. **Attachment maximum size** defines the maximum size of an attachment (for example in a work package).
|
||||
|
||||
3. **Object per page options** define the options of how many objects (for example work packages or news entries) you can have displayed on one page. This is used for the pagination in the work package list. You can enter several values, separated by coma. Please note that the higher value you set, the more work packages will be initially loaded and therefore it might take longer time to load a work package page.
|
||||
|
||||
4. **Days displayed on project activity** determines how far back the project activities will be traced and displayed in the project's [Activity](../../../user-guide/activity).
|
||||
@@ -34,18 +32,21 @@ You can configure general system settings in OpenProject. Under System settings
|
||||
|
||||
12. **Display security badge** enables to display a badge with your installation status in the [Information administration panel](../../information), and on the [start page](../../../user-guide/start-page). It is displayed to administrators only.
|
||||
|
||||
The badge will check your current OpenProject version against the official OpenProject release database to alert you of any updates or known vulnerabilities. For more information on what the check provides, what data is needed to provide available updates, and how to disable this check, please visit [the configuration documentation](../../information#security-badge).
|
||||
|
||||
|
||||
*Note: if enabled, this will display a badge with your installation status in the* [Information](https://qa.openproject-edge.com/admin/info) *administration panel, and on the home page. It is displayed to administrators only.*
|
||||
|
||||
*The badge will check your current OpenProject version against the official OpenProject release database to alert you of any updates or known vulnerabilities. For more information on what the check provides, what data is needed to provide available updates, and how to disable this check, please visit* [the configuration documentation](https://docs.openproject.org/system-admin-guide/information/#security-badge)*.*
|
||||
|
||||
## Welcome block text
|
||||
|
||||
Create a welcome text block to display the most important information to users on your [application start page](../../../user-guide/start-page).
|
||||
|
||||
1. Insert a **welcome block title**.
|
||||
|
||||
2. Add the **welcome block text description**. You can add the same formatting options, as well as macros (work package lists etc.) as for the general text blocks.
|
||||
|
||||
3. Select to **display welcome block on homescreen** of the application.
|
||||
|
||||
4. Do not forget to **save** your changes.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 114 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 114 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 103 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 95 KiB |
@@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_navigation:
|
||||
title: Project system settings
|
||||
priority: 800
|
||||
priority: 950
|
||||
description: Project system settings in OpenProject.
|
||||
robots: index, follow
|
||||
keywords: project system settings
|
||||
@@ -14,13 +14,10 @@ To adapt the system project settings, navigate to *Administration -> System sett
|
||||
|
||||
1. Check if **new projects are public by default**. This means that users without an account can access the project without login.
|
||||
2. Select **which modules should be activated for newly created projects by default**.
|
||||
3. The **role given to a user in a new project when the user creates a new project but is not an (global) admin**. This makes sense when a user receives the permission to create a new project via [global role](../../users-permissions/roles-permissions/#global-roles).
|
||||
|
||||
|
||||
3. The **role given to a user in a new project when the user creates a new project but is not an (global) admin**. This makes sense when a user receives the permission to create a new project via [global role](../../users-permissions/roles-permissions/#global-roles).
|
||||
|
||||
## Settings for the Projects Overview List
|
||||
1. Choose **which columns should be visible** in the Projects Overview List by default.
|
||||
2. Define the **settings for the Gantt chart view** displayed when clicking on "Open as Gantt view" in the [Projects Overview List](../../../user-guide/projects/#global-projects-overview---view-all-projects). You can choose filters, columns, sorting and more to configure the view. For more information on how the configuration works please refer to the instructions for the [work package table configuration](../../../user-guide/work-packages/work-package-table-configuration/) in the User guide (as the basic principles are the same).
|
||||
3. Do not forget to **save** your changes.
|
||||
|
||||
|
||||
|
||||
|
||||
BIN
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
@@ -21,7 +21,7 @@ To adapt repositories settings, go to System settings on the tab **Repositories*
|
||||
9. Define the **maximum number of files displayed in the repository browser**.
|
||||
10. **Enable caching for authentication request of version control software**. This option allows saving the authentication so that a user doesn’t have to authenticate every time a repository is accessed (for example during commits).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 180 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 179 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 191 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 182 KiB |
@@ -10,15 +10,16 @@ keywords: notifications
|
||||
|
||||
This section will introduce in-app notifications and explain how to work with them.
|
||||
|
||||
## Overview of in-app notifications in OpenProject
|
||||
|
||||
|
||||
In-app notifications are a tool to get notified about requests, changes and new assignments in OpenProject. The notifications can work as an alternative to email notification, or be used in parallel. This feature is enabled by default.
|
||||
|
||||
## Accessing in-app notifications
|
||||
|
||||
Whenever you are getting in-app notification, a red elliptical with the number of notifications is displayed on the bell symbol on the upper right side of the OpenProject screen between the module button and the help button. (Please note, if there are more than 99 notifications, the elliptical will simply be red without a number in it).
|
||||
|
||||
|
||||
|
||||
To view the notifications, please left-click on the bell symbol. By default, your notifications are sorted by work package.
|
||||
To view the notifications, please left-click on the bell symbol. By default, your notifications are sorted by work package.
|
||||
|
||||
|
||||
|
||||
@@ -36,21 +37,22 @@ By clicking on a row in the notification center, you will see the details in the
|
||||
|
||||
|
||||
|
||||
|
||||
To make viewing notifications more manageable, OpenProject includes several ways to filter or group notifications.
|
||||
|
||||
You can filter or group the notifications using the two areas in the left menu bar (1 and 2), or bulk edit notifications by selecting options in the top right (3) of the screen:
|
||||
|
||||
1. **1**You can filter by your **involvement**, for example filter for notifications that originated from mentions (@mentioned), from work packages you were assigned to or were accountable for or are simply watching.
|
||||
1. ****You can filter by your **involvement**, for example filter for notifications that originated from mentions (@mentioned), from work packages you were assigned to or were accountable for or are simply watching.
|
||||
|
||||
2. **2**You can filter by **project**, for example filter for notifications that originated from a specific project.
|
||||
2. You can filter by **project**, for example filter for notifications that originated from a specific project.
|
||||
|
||||
3. **3**You can also filter notifications for "**Unread**" or "**All**" (Read and Unread) notifications, and "**Mark all as read**". Please note that the "**Mark all as read**" button only marks notifications that are currently in view. You may have to ultimately press "**Mark all as read**" multiple times to mark all of your notifications as read if you have a lot of them. The red elliptical will update the number of unread messages in real-time, and eventually disappear when there are no more unread notifications.
|
||||
3. ****You can also filter notifications for "**Unread**" or "**All**" (Read and Unread) notifications, and "**Mark all as read**". Please note that the "**Mark all as read**" button only marks notifications that are currently in view. You may have to ultimately press "**Mark all as read**" multiple times to mark all of your notifications as read if you have a lot of them. The red elliptical will update the number of unread messages in real-time, and eventually disappear when there are no more unread notifications.
|
||||
To mark and individual message as read, click on the small envelope icon next to the blue notification bubble.
|
||||
|
||||
|
||||
|
||||
4. The [**Notification settings**](./notification-settings/) button will bring you to your personal notification settings to configure your notification preferences.
|
||||
|
||||
4. The [**Notification settings**](/notification-settings) button will bring you to your personal notification settings to configure your notification preferences.
|
||||
|
||||
5. When selecting any of the notifications, you can also view more **details in the split screen**, for example comments members made regarding a specific work package. Unread messages are indicated by a blue bubble. You can even edit directly in this view.
|
||||
|
||||
In addition to the in-app notifications, you will also get a once-a-day summary of all notifications by email. To fine-tune Email Reminders, [click here](../../getting-started/my-account/#email-reminders).
|
||||
In addition to the in-app notifications, you will also get a once-a-day summary of all notifications by email. To fine-tune Email Reminders, [click here](../../getting-started/my-account/#email-reminders).
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 268 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 325 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 364 KiB After Width: | Height: | Size: 1.4 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
@@ -8,7 +8,8 @@ keywords: notifications settings
|
||||
---
|
||||
## Notification settings
|
||||
|
||||
To access the in-app notification settings. Please left-click the **Notification settings** button in the upper right side of the [notification center](../) or navigate via **My account > Notification settings**.
|
||||
|
||||
To access the in-app notification settings. Please left-click the **Notification settings** button in the upper right side of the [notification center](../notifications) or navigate via **My account > Notification settings**.
|
||||
|
||||
|
||||
|
||||
@@ -24,12 +25,8 @@ In the **Notification settings** you can fine-tune what you are notified about:
|
||||
- All priority changes
|
||||
- All new comments
|
||||
|
||||
When someone [mentions](../../work-packages/edit-work-package/#-notification-mention) you (@xxx) in e.g. a work package description or comment you will receive an in-app notification.
|
||||
When someone [mentions](../../user-guide/work-packages/edit-work-package/#-notification-mention) you (@xxx) in e.g. a work package description or comment you will receive an in-app notification.
|
||||
|
||||
Additionally, you can also add **project specific notification settings** by clicking on the link **Add settings for project**.
|
||||
|
||||
|
||||
|
||||
By default you do not receive any notifications about your own changes. In addition to the in-app notifications, you will also get a once-a-day summary of all notifications as **[Email reminders](../../../getting-started/my-account#email-reminders)**.
|
||||
|
||||
___
|
||||
By default you do not receive any notifications about your own changes. In addition to the in-app notifications, you will also get a once-a-day summary of all notifications as **[Email reminders](../../../getting-started/my-account#email-reminders)**.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 209 KiB |
Reference in New Issue
Block a user