Skip to content

Commit

Permalink
update docs (#874)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Apr 29, 2024
1 parent 9d4375d commit 4c6e73a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Added
- REST API views (#1350)
- ``get_project()`` helpers in ``TimelineEvent`` and ``TimelineEventObjectRef`` (#1350)
- Optional pagination for REST API list views (#1313)
- **Userprofile**
- Additional email address management and verification (#874)

Changed
-------
Expand Down
23 changes: 23 additions & 0 deletions docs/source/app_userprofile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,26 @@ Receive Email for Project Membership Updates

In the development setup, the SODAR Core example site apps also provide
additional settings for demonstrating settings features.


Additional Emails
=================

The user can configure additional emails for their user account in case they
want to receive automated emails to addresses other than their primary address.
The user profile view displays additional emails and provides controls for
managing these addresses.

.. hint::

Managing addresses is only possible on a source site. On a target site,
emails will be visible but not mofifiable.

A new additional email address can be added with a form accessible by clicking
on the :guilabel:`Add Email` button. After creation, a verification email will
be sent to the specified address. Opening a link contained in the email and
logging into the site will verify the email. Only verified email addresses will
receive automated emails from the site.

For each email address displayed in the list, there are controls to re-send the
verification email (in case of an unverified email) and deleting the address.
1 change: 1 addition & 0 deletions docs/source/major_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Release Highlights
- Add timeline REST API
- Add optional pagination for REST API list views
- Add admin alert email sending to all users
- Add improved additional email address management and verification
- Add user opt-out settings for email notifications
- Add target site user UUID updating in remote sync
- Add remote sync of existing target local users
Expand Down

0 comments on commit 4c6e73a

Please sign in to comment.