Skip to content

Commit

Permalink
[#58835] 15.0 Documentation: my account re-naming docs changes (#17124)
Browse files Browse the repository at this point in the history
* [#58835] 15.0 Documentation: Remove "Beta" label from Dark mode selection  https://community.openproject.org/work_packages/58835

[#58835] 15.0 Documentation: Remove "Beta" label from Dark mode selection

https://community.openproject.org/work_packages/58835

* update

* fix links to moved docs page

---------

Co-authored-by: Andrej Sandorf <[email protected]>
Co-authored-by: as-op <[email protected]>
  • Loading branch information
3 people authored Nov 11, 2024
1 parent 537e43c commit 60c169f
Show file tree
Hide file tree
Showing 77 changed files with 131 additions and 128 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ OpenProject provides means to fully erase both all identifiable information of a

- Data controllers can perform the deletion [through the administration](../../../system-admin-guide/users-permissions/users/).

- Depending on the configuration of your OpenProject instance, individual data subjects may perform the deletion of their own account through the [Delete Account](../../../user-guide/my-account/) page. If this is disabled, the request may be stated to the data controller.
- Depending on the configuration of your OpenProject instance, individual data subjects may perform the deletion of their own account through the [Delete Account](../../../user-guide/account-settings/) page. If this is disabled, the request may be stated to the data controller.

### Data Portability

Expand Down
4 changes: 2 additions & 2 deletions docs/faq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ Please find information on the features of OpenProject [here](https://www.openpr

### Is it possible to use multiple languages in OpenProject?

Yes, it is possible to use OpenProject in multiple languages. We support English, German, French and a number of additional languages. Each user can select their own preferred language by signing into OpenProject, clicking on the user avatar on the upper right side and selecting "My account" from the dropdown menu.
You can then select "Settings" from the side menu on the left side and [change the language](../user-guide/my-account/#change-your-language).
Yes, it is possible to use OpenProject in multiple languages. We support English, German, French and a number of additional languages. Each user can select their own preferred language by signing into OpenProject, clicking on the user avatar on the upper right side and selecting "Account settings" from the dropdown menu.
You can then select "Settings" from the side menu on the left side and [change the language](../user-guide/account-settings/#change-your-language).

### Is there an OpenProject app?

Expand Down
20 changes: 10 additions & 10 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ Here you will learn about the **first steps with OpenProject**. If you need more

## Overview

| Topic | Content |
|---------------------------------------------------------|:---------------------------------------------------------------|
| Topic | Content |
| ------------------------------------------------------- | :----------------------------------------------------------- |
| [Introduction to OpenProject](openproject-introduction) | Get an introduction about project management with OpenProject. |
| [Sign in and registration](sign-in-registration) | Find out how you can register and sign in to OpenProject. |
| [Create a project](projects) | How to create and set up a new project. |
| [Invite team members](invite-members) | How to invite new members. |
| [Work packages](work-packages-introduction) | Learn how to create and edit work packages. |
| [Gantt chart](gantt-chart-introduction) | Find out how to create a project plan. |
| [Boards](boards-introduction) | How to work with agile boards. |
| [My account](my-account) | How to configure my account. |
| [My page](my-page) | Find out more about a personal my page dashboard. |
| [Sign in and registration](sign-in-registration) | Find out how you can register and sign in to OpenProject. |
| [Create a project](projects) | How to create and set up a new project. |
| [Invite team members](invite-members) | How to invite new members. |
| [Work packages](work-packages-introduction) | Learn how to create and edit work packages. |
| [Gantt chart](gantt-chart-introduction) | Find out how to create a project plan. |
| [Boards](boards-introduction) | How to work with agile boards. |
| [Account settings](account-settings) | How to configure personal account settings. |
| [My page](my-page) | Find out more about a personal my page dashboard. |

## 6 steps to get started

Expand Down
20 changes: 20 additions & 0 deletions docs/getting-started/account-settings/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_navigation:
title: My account
priority: 400
description: Learn how to configure account settings.
keywords: my account, account settings, change language
---

# Account settings

Under **Account settings**, you can change your personal settings, such as the language, edit notifications, or add an avatar. Moreover you can manage access tokens and sessions.

> [!TIP] Prior to OpenProject 15.0 *Account settings* were named *My account*.
To open your personal settings in OpenProject, click on your user icon in the top right corner in the header of the application and choose **Account settings**.

![Account settings in OpenProject](openproject_open_account_settings.png)

For more details please take a look at [**Account settings** section of OpenProject user guide](../../user-guide/account-settings).

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 0 additions & 18 deletions docs/getting-started/my-account/README.md

This file was deleted.

Binary file not shown.
2 changes: 1 addition & 1 deletion docs/getting-started/sign-in-registration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ After the creation of your account you are logged into the system. You will then
![select language](20191202171349241.png)

If you have already logged in before, you can [set your language in your user profile](../../user-guide/my-account/#profile-settings).
If you have already logged in before, you can [set your language in your user profile](../../user-guide/account-settings/#profile-settings).

## Reset your password

Expand Down
6 changes: 3 additions & 3 deletions docs/glossary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ A custom query in OpenProject consists of saved [filters](#filters), sort criter

### Dark mode

The dark mode for OpenProject is a personal setting to display the application in a dark [theme](#theme). Other available modes are the regular light mode and the (light) [high contrast mode](#high-contrast-mode). [Read in our documentation how to enable dark mode](../user-guide/my-account/#select-the-dark-mode).
The dark mode for OpenProject is a personal setting to display the application in a dark [theme](#theme). Other available modes are the regular light mode and the (light) [high contrast mode](#high-contrast-mode). [Read in our documentation how to enable dark mode](../user-guide/account-settings/#select-the-dark-mode).

### Dashboard

Expand Down Expand Up @@ -201,7 +201,7 @@ A Group in OpenProject is defined as a list of users which can be added as a mem

### High contrast mode

OpenProject offers a high contrast mode to make it easier for visually impaired people to use the software. This mode can be selected in the personal [account settings](../user-guide/my-account/#my-account) and will only affect the individual user's experience.
OpenProject offers a high contrast mode to make it easier for visually impaired people to use the software. This mode can be selected in the personal [account settings](../user-guide/account-settings/) and will only affect the individual user's experience.

### Home page

Expand Down Expand Up @@ -476,4 +476,4 @@ A list of work packages is considered a view. The containing work packages in an

### WYSIWYG editor

WYSIWYG stands for 'What you see is what you get'. A WYSIWYG editor is a content editing interface that allows users to create and edit content so that it visually resembles the final result. In OpenProject, you can use WYSIWYG editors in [wikis](#wiki), [forums](#forum) and [work package](#work-package) descriptions and comments.
WYSIWYG stands for 'What you see is what you get'. A WYSIWYG editor is a content editing interface that allows users to create and edit content so that it visually resembles the final result. In OpenProject, you can use WYSIWYG editors in [wikis](#wiki), [forums](#forum) and [work package](#work-package) descriptions and comments.
2 changes: 1 addition & 1 deletion docs/release-notes/12/12-0-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The new in-app notifications let you never miss a change in your projects again.

Go to our user guide to find out how to [configure in-app notifications](../../../user-guide/notifications/).

> **Info:** Please note that starting with version 12.0, OpenProject will no longer send individual emails for each notification. You can view your notifications via the new [Notification center](../../../user-guide/notifications/#access-in-app-notifications). You can however still choose to receive daily [email reminders](../../../user-guide/my-account/#email-reminders) at specific times of the day that you can configure.
> **Info:** Please note that starting with version 12.0, OpenProject will no longer send individual emails for each notification. You can view your notifications via the new [Notification center](../../../user-guide/notifications/#access-in-app-notifications). You can however still choose to receive daily [email reminders](../../../user-guide/account-settings/#email-reminders) at specific times of the day that you can configure.
## Notification center

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/12/12-4-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ With OpenProject 12.4 users who have OpenProject community edition installed can

![two-factor-authentication](openproject-2-factor-authentication-community-edition.png)

!See [here](../../../user-guide/my-account/#two-factor-authentication) how to setup the 2FA under My account.
!See [here](../../../user-guide/account-settings/#two-factor-authentication) how to setup the 2FA under My account.

## LDAP connection encryption changes

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/13-1-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ With OpenProject 13.1, we released [Attribute help texts](../../system-admin-gui

## Accessibility improvements and high contrast mode

We continued to work on improving accessibility of OpenProject according to the WCAG 2.1 AA. You can now select to use a high contrast mode in your [profile settings](../../user-guide/my-account/#select-the-high-contrast-color-mode), which will override the current OpenProject theme and be especially valuable for OpenProject users with visual impairments.
We continued to work on improving accessibility of OpenProject according to the WCAG 2.1 AA. You can now select to use a high contrast mode in your [profile settings](../../user-guide/account-settings/#select-the-high-contrast-color-mode), which will override the current OpenProject theme and be especially valuable for OpenProject users with visual impairments.

![High contrast mode in OpenProject](openproject_my_account_high_contrast_mode.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/14-4-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more details, see https://community.openproject.org/wp/56861.

### Personal settings: Dark mode

Dark mode for OpenProject is finally here! In the '[My account](../../user-guide/my-account/#profile-settings)' section under 'Settings', there is an **option labeled 'Mode' where users can now select 'Dark (Beta).'** – as an alternative to the light mode. When the dark mode is selected, the change applies only to that user, not to the entire instance.
Dark mode for OpenProject is finally here! In the '[My account](../../user-guide/account-settings/#profile-settings)' section under 'Settings', there is an **option labeled 'Mode' where users can now select 'Dark (Beta).'** – as an alternative to the light mode. When the dark mode is selected, the change applies only to that user, not to the entire instance.

![News setting for dark mode in OpenProject, displayed in dark mode](openproject-14-4-dark-mode.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/system-admin-guide/api-and-webhooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Navigate to **Administration → API and webhooks**.

![API settings in OpenProject administration](openproject_system_admin_guide_api.png)

Here, you can manage the **REST web service** to selectively control whether foreign applications may access your OpenProject API endpoints from within the browser. This setting allows users to access the OpenProject API using an API token created from the users "My account" page. You can set the **maximum page size** the API will respond with. It will not be possible to perform API requests that return more values on a single page. You can also enable **write access to read-only attributes**, which will allow administrators to write static read-only attributes during creation, such as *createdAt* and *author*.
Here, you can manage the **REST web service** to selectively control whether foreign applications may access your OpenProject API endpoints from within the browser. This setting allows users to access the OpenProject API using an API token created from the users "Account settings" page. You can set the **maximum page size** the API will respond with. It will not be possible to perform API requests that return more values on a single page. You can also enable **write access to read-only attributes**, which will allow administrators to write static read-only attributes during creation, such as *createdAt* and *author*.

### Documentation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To activate and **configure two-factor authentication** for OpenProject, navigat

From the GUI you are able to configure the following options:

1. **Enforce 2FA** (two-factor authentication) for every user. All users will be forced to [register a 2FA device](../../../user-guide/my-account/#two-factor-authentication) on their next login.
1. **Enforce 2FA** (two-factor authentication) for every user. All users will be forced to [register a 2FA device](../../../user-guide/account-settings/#two-factor-authentication) on their next login.
2. **Remember 2FA login** for a given number of days, e.g. 30 days.
3. Press the **Apply** button to save your changes.

Expand Down
2 changes: 1 addition & 1 deletion docs/system-admin-guide/emails-and-notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ To configure **Incoming emails** in OpenProject, navigate to **Administration

**To set up incoming email**, please visit our [Operations guide](../../installation-and-operations/configuration/incoming-emails).

**To configure individual email reminders**, please visit our [User guide](../../user-guide/my-account/#email-reminders).
**To configure individual email reminders**, please visit our [User guide](../../user-guide/account-settings/#email-reminders).
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ terms instead, defined in the [relations model](https://github.com/opf/openproje
![Choose-project-900x479@2x]([email protected])

**URL**: the URL of your OpenProject instance.
**API-Token**: can be generated within your OpenProject installation ->*My Account* -> *Access token*. Generate a new API token and copy & paste it to this form.
**API-Token**: can be generated within your OpenProject installation ->*Account settings* -> *Access token*. Generate a new API token and copy & paste it to this form.
**Project**: this is the project identifier which can be found within the project you want to synchronize -> *Project settings* -> *Information*. It is also shown in the URL if you open a project.
Query ID (this field is optional): enter the ID of a work package query within a project with that you want to synchronize your Excel list.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,18 @@ The role needs two permissions and should only receive those two: "View work pac

![GitHub user added as member to project with respective role](github-project-member.png)

Once the user is created you need to generate an OpenProject API token for it
to use later on the GitHub side of things. For this you have to:
Once the user is created you need to generate an OpenProject API token for this user (you will need it on the GitHub side). For this you have to:

1. Login as the newly created user
2. Go to My Account (click on Avatar in top right corner)
3. Go to Access Token
4. Click on generate in the API row
2. Go to [Account settings](../../../user-guide/account-settings/) (click on the Avatar in the top right corner and select *Account settings*)
3. Go to [*Access Tokens*](../../../user-guide/account-settings/#access-tokens)
4. Click on **+ API token**

Copy the generated key. You can then configure the necessary webhook in GitHub.
> Make sure you copy the generated key and securely save it, as you will not be able to retrieve it later.
In addition, in *Project settings* and *Modules* you will need to activate the GitHub module so that all information pulling through from GitHub will be shown in the work packages.
You can then configure the necessary webhook in GitHub.

Finally you will need to activate the GitHub module under [Project settings](../../../user-guide/projects/project-settings/modules/) so that all information pulling through from GitHub will be shown in the work packages.

![GitHub-module](Github-module-2647262.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ This user will then have to be **added to each project** with a role that allows
Once the user is created you need to generate an OpenProject API token for this user (you will need it on the GitLab side). For this you have to:

1. Login as the newly created user
2. Go to [My Account](../../../user-guide/my-account/) (click on the Avatar in the top right corner and select *My account*)
3. Go to [*Access Tokens*](../../../user-guide/my-account/#access-tokens)
2. Go to [Account settings](../../../user-guide/account-settings/) (click on the Avatar in the top right corner and select *Account settings*)
3. Go to [*Access Tokens*](../../../user-guide/account-settings/#access-tokens)
4. Click on **+ API token**

> Make sure you copy the generated key and securely save it, as you will not be able to retrieve it later.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ At the moment there are over 30 languages available.
> [!NOTE]
> Many languages are translated by the community. We highly appreciate if you want to [help translating OpenProject to your language](../../../development/translate-openproject).
You can [choose your language in your user profile](../../../user-guide/my-account/#change-your-language).
You can [choose your language in your user profile](../../../user-guide/account-settings/#change-your-language).
4 changes: 2 additions & 2 deletions docs/system-admin-guide/users-permissions/settings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The default language is displayed for users when they first sign into OpenProjec

You can also choose if success notifications (e.g. on the work package page) should be hidden automatically.

These settings can be changed by users in their **My Account** page later on.
These settings can be changed by users in their **Account settings** page later on.

## Display format

Expand All @@ -49,7 +49,7 @@ In the **User deletion** section you can determine who should be able to delete

By default, only admins are able to delete accounts. If this option is activated, admins can navigate to the user list, select a user account and click on the **Delete** option on the upper right side to delete an account.

Additionally, you can select the option **Users allowed to delete their accounts**. If this option is activated, users can delete their own user accounts from the **My account** page.
Additionally, you can select the option **Users allowed to delete their accounts**. If this option is activated, users can delete their own user accounts from the **Account settings** page.

If you want to prevent users from deleting their own accounts, it is recommended to deactivate this option.

Expand Down
Loading

0 comments on commit 60c169f

Please sign in to comment.