Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#58835] 15.0 Documentation: my account re-naming docs changes #17124

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/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 @@ -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/my-account/#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,7 +47,7 @@ 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*)
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/my-account/#access-tokens)
4. Click on **+ API token**

Expand Down
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
10 changes: 4 additions & 6 deletions docs/system-admin-guide/users-permissions/users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Please note: this only works for users who haven't logged in yet. If the user is

## Manage user settings

You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their **My Account** settings.
You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their **Account settings**.

### General settings

Expand Down Expand Up @@ -168,13 +168,11 @@ On the **Global roles** tab, select or de-select the global role(s) for this use

### Notification settings

Under **Notification settings** tab you can edit the [notification settings](../../../user-guide/notifications/notification-settings/) for the user. Each user can adjust these settings under [My account](../../../user-guide/my-account) on their own.
Under **Notification settings** tab you can edit the [notification settings](../../../user-guide/notifications/notification-settings/) for the user. Each user can adjust these settings under [Account settings](../../../user-guide/account-settings) on their own.

### Email reminders

Under **Email reminders** tab you can edit the [email reminders settings](../../../user-guide/my-account/#email-reminders). Each user can adjust these settings under [My account](../../../user-guide/my-account) on their own.

### Rate history
Under **Email reminders** tab you can edit the [email reminders settings](../../../user-guide/account-settings/#email-reminders). Each user can adjust these settings under [Account settings](../../../user-guide/account-settings) on their own.

The rate history tab shows the hourly rates that have been defined for the user. The **Default rate** is applied to projects with no rate defined. All projects that the user is a member of are listed with the user's rates.

Expand Down Expand Up @@ -225,7 +223,7 @@ Leave all fields blank. When the details are saved OpenProject will send an emai
Two [settings](../settings/#user-deletion) allow users to be deleted from the system:

* **User accounts deletable by admins** - if ticked, a **Delete** button is shown on the user details page.
* **Users allowed to delete their accounts** - if ticked, a **Delete account** menu entry is shown in the **My Account** page.
* **Users allowed to delete their accounts** - if ticked, a **Delete account** menu entry is shown in the **Account settings** page.

To delete another user's account open the [user list](#user-list). Click on the **user name** of the user which you want to delete. Click the **Delete** button at the top right.

Expand Down
Loading
Loading