Skip to content

Commit

Permalink
documentation: add user settings section to user manual
Browse files Browse the repository at this point in the history
  • Loading branch information
dmijatovic committed Nov 22, 2023
1 parent 4fd63af commit f075c99
Show file tree
Hide file tree
Showing 12 changed files with 57 additions and 2 deletions.
42 changes: 42 additions & 0 deletions documentation/docs/01-users/08-user-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# User settings

You can access user settings via user menu at the top right side of the screen.

![image](img/user-settings.webp)

## My software

This section lists all software where you are one of the maintainers.

:::tip
It is possible to list all software where you are mentioned as contributor by linking your ORCID account and enabling your [public profile](#public-profile).
:::

## My projects

This section lists all projects where you are one of the maintainers.

:::tip
It is possible to list all projects where you are mentioned as team member by linking your ORCID account and enabling your [public profile](#public-profile).
:::

## My organisations

This section list all organisations where you are one of the maintainers.

## User agreements

To be able to contribute to the RSD, we need to know that you agree to our Terms of Service, and that you have read the Privacy Statement.

## Public profile

If you have ORCID you can link you ORCID account to RSD. There are two benefits of linking ORCID

- You can login to RSD using your ORCID credentials
- You can enable your public profile and see all software and project items that mention you by ORCID

### How the public profile works?

After you link your ORCID account in RSD you can enable your public profile in the settings. By enabling public profile you are giving the permission to RSD to link all contributor and team member entries in the RSD that use your ORCID into your public profile. By enabling the public profile you will be able to see all software and projects where are you mentioned as contributor or team member.

![animation](img/user-public-profile.gif)
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
SPDX-FileCopyrightText: 2023 Dusan Mijatovic (Netherlands eScience Center)
SPDX-FileCopyrightText: 2023 Dusan Mijatovic (dv4all) (dv4all)
SPDX-FileCopyrightText: 2023 Netherlands eScience Center
SPDX-FileCopyrightText: 2023 dv4all

SPDX-License-Identifier: CC-BY-4.0
File renamed without changes.
File renamed without changes.
6 changes: 6 additions & 0 deletions documentation/docs/01-users/11-cookies.md.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
SPDX-FileCopyrightText: 2023 Dusan Mijatovic (Netherlands eScience Center)
SPDX-FileCopyrightText: 2023 Dusan Mijatovic (dv4all) (dv4all)
SPDX-FileCopyrightText: 2023 Netherlands eScience Center
SPDX-FileCopyrightText: 2023 dv4all

SPDX-License-Identifier: CC-BY-4.0
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
SPDX-FileCopyrightText: 2023 Dusan Mijatovic (dv4all) (dv4all)
SPDX-FileCopyrightText: 2023 dv4all

SPDX-License-Identifier: Apache-2.0
Binary file not shown.
5 changes: 3 additions & 2 deletions frontend/components/user/settings/UserAgreementsSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import Link from 'next/link'
import {useFormContext} from 'react-hook-form'
import useRsdSettings from '~/config/useRsdSettings'
import ControlledSwitch from '~/components/form/ControlledSwitch'
import {UserSettingsType} from './useUserAgreements'

type UserAgreementsProps = {
agree_terms?:boolean,
Expand Down Expand Up @@ -42,7 +43,7 @@ export default function UserAgreementsSection({
}:UserAgreementsProps) {

const {host} = useRsdSettings()
const {control} = useFormContext()
const {control, watch} = useFormContext<UserSettingsType>()

return(
<form
Expand Down Expand Up @@ -86,7 +87,7 @@ export default function UserAgreementsSection({
control={control}
onSave={setPublicOrcidProfile}
label={
<span>Enable my public profile (requires to link your ORCID account)</span>
<span>Enable my <Link className="underline" target='_blank' href="/documentation/users/user-settings/#public-profile">Public Profile</Link></span>
}
/>
</div>
Expand Down

0 comments on commit f075c99

Please sign in to comment.