diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 0ad3e9d..8f5040a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -37,6 +37,7 @@ module.exports = { 'online-demo', 'getting-access', 'register-organization', + 'maintain-organisation', 'adding-software', 'adding-projects', 'faq', diff --git a/docs/.vuepress/public/affiliation-denied.png b/docs/.vuepress/public/affiliation-denied.png new file mode 100644 index 0000000..944a471 Binary files /dev/null and b/docs/.vuepress/public/affiliation-denied.png differ diff --git a/docs/.vuepress/public/affiliation-denied.png.license b/docs/.vuepress/public/affiliation-denied.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/affiliation-denied.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/email-invite.png b/docs/.vuepress/public/email-invite.png new file mode 100644 index 0000000..64b4730 Binary files /dev/null and b/docs/.vuepress/public/email-invite.png differ diff --git a/docs/.vuepress/public/email-invite.png.license b/docs/.vuepress/public/email-invite.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/email-invite.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/my-organisations.png b/docs/.vuepress/public/my-organisations.png new file mode 100644 index 0000000..6b2eaa5 Binary files /dev/null and b/docs/.vuepress/public/my-organisations.png differ diff --git a/docs/.vuepress/public/my-organisations.png.license b/docs/.vuepress/public/my-organisations.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/my-organisations.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/organisation-maintainers.png b/docs/.vuepress/public/organisation-maintainers.png new file mode 100644 index 0000000..10d1fea Binary files /dev/null and b/docs/.vuepress/public/organisation-maintainers.png differ diff --git a/docs/.vuepress/public/organisation-maintainers.png.license b/docs/.vuepress/public/organisation-maintainers.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/organisation-maintainers.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/organisation-metadata-card.png b/docs/.vuepress/public/organisation-metadata-card.png new file mode 100644 index 0000000..e154f6c Binary files /dev/null and b/docs/.vuepress/public/organisation-metadata-card.png differ diff --git a/docs/.vuepress/public/organisation-metadata-card.png.license b/docs/.vuepress/public/organisation-metadata-card.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/organisation-metadata-card.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/organisation-metadata.png b/docs/.vuepress/public/organisation-metadata.png new file mode 100644 index 0000000..9d35e4c Binary files /dev/null and b/docs/.vuepress/public/organisation-metadata.png differ diff --git a/docs/.vuepress/public/organisation-metadata.png.license b/docs/.vuepress/public/organisation-metadata.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/organisation-metadata.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/pencil.png b/docs/.vuepress/public/pencil.png new file mode 100644 index 0000000..8a2f958 Binary files /dev/null and b/docs/.vuepress/public/pencil.png differ diff --git a/docs/.vuepress/public/pencil.png.license b/docs/.vuepress/public/pencil.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/pencil.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/pin-software.png b/docs/.vuepress/public/pin-software.png new file mode 100644 index 0000000..11822e2 Binary files /dev/null and b/docs/.vuepress/public/pin-software.png differ diff --git a/docs/.vuepress/public/pin-software.png.license b/docs/.vuepress/public/pin-software.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/pin-software.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/pinned-software.png b/docs/.vuepress/public/pinned-software.png new file mode 100644 index 0000000..79df6fe Binary files /dev/null and b/docs/.vuepress/public/pinned-software.png differ diff --git a/docs/.vuepress/public/pinned-software.png.license b/docs/.vuepress/public/pinned-software.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/pinned-software.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/research-unit-modal.png b/docs/.vuepress/public/research-unit-modal.png new file mode 100644 index 0000000..83e485b Binary files /dev/null and b/docs/.vuepress/public/research-unit-modal.png differ diff --git a/docs/.vuepress/public/research-unit-modal.png.license b/docs/.vuepress/public/research-unit-modal.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/research-unit-modal.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/.vuepress/public/trash.png b/docs/.vuepress/public/trash.png new file mode 100644 index 0000000..faf67dc Binary files /dev/null and b/docs/.vuepress/public/trash.png differ diff --git a/docs/.vuepress/public/trash.png.license b/docs/.vuepress/public/trash.png.license new file mode 100644 index 0000000..b751abf --- /dev/null +++ b/docs/.vuepress/public/trash.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2023 Christian Meeßen (GFZ) +SPDX-FileCopyrightText: 2023 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/README.md b/docs/README.md index 2ca904b..a70f207 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,8 @@ actions: type: primary - text: How to register organizations link: /register-organization.html + - text: Maintain organisations + link: /maintain-organisation.html type: primary - text: Documentation link: /introduction.html diff --git a/docs/maintain-organisation.md b/docs/maintain-organisation.md new file mode 100644 index 0000000..496b55e --- /dev/null +++ b/docs/maintain-organisation.md @@ -0,0 +1,152 @@ + + +# Maintaining organisations + +Organisations have the opportunity to maintain their representation within the RSD. +In order to achieve this, official representatives of the organisation can take on the role of maintainers of their organisation. + +## How to claim an organisation + +If you would like to claim an organisation, please have a look at [Register or claim an organization](register-organization.md). + +## What can organisation maintainers do + +To edit your organisations, open the organisation either via the __Organisations list__, or your the __My organisations__ option in your __User profile__. + +![Screenshot of user menu](/my-organisations.png) + +The RSD distinguishes between __primary__ and __invited maintainers__. +Here is an overview of what each of them can do: + +| | Primary maintainer | Invited maintainer | +|----------------------------------------|:------------------:|:------------------:| +| Edit About section | x | x | +| Upload/delete logo | x | x | +| Edit organisation metadata | x | x | +| Reject affiliations (software/project) | x | x | +| Pin/unpin software/projects | x | x | +| Add new research units | x | | +| Invite maintainers | x | x | +| Remove maintainers (not primary) | x | x | +| Remove/change primary maintainer * | | | +| Change organisation URL path * | | | + +(*) These actions can only be perfomred by administators. If necessary, contact us via [rsd@esciencecenter.nl](mailto:rsd@esciencecenter.nl). + +### Manage metadata + +Under __"Settings"__ you can edit: + + + + + + + + + + + + + + +
NameWill be displayed when your organisation is referenced
ROR idUsed to display metadata in the organsation's card (see Edit logo)
WebsiteUsed in the organsation's card (see Edit logo)
+ +![Screenshot of organisation settings](/organisation-metadata.png) + +### Edit logo + +Below the settings in the sidebar, you can edit the logo of your organisation: + +![Screenshot of organisation metadata card](/organisation-metadata-card.png) + +You can upload a new logo ![Pencil icon](/pencil.png), or remove ![Trash icon](/trash.png) it. +The RSD supports common image formats, e.g. jpg, png or svg. + +::: tip +If possible, please upload an __SVG__ version of your organisation's logo for optimal visual presentation within the RSD. +::: + +### Edit About Section + +In the __"About"__ section, relevant information about your organisation can be added in a free text form. +To edit the content of the section, please navigate to __"Settings"__ and scroll down to the __"About page"__ section (see [Manage metadata](#manage-metadata)). +The text can be formatted using the [Markdown syntax](https://www.markdownguide.org/basic-syntax/). + +### Manage maintainers + +As a maintainer, you can invite or remove other maintainers from your organisation. +A list of existing maintainers will be shown: + +![Screenshot of organisation maintainers](/organisation-maintainers.png) + +::: warning +The __primary maintainer__ of an organisation cannot be removed (in this example "Maintainer 1"). +If you want to exchange the primary maintainer, contact us via [rsd@esciencecenter.nl](mailto:rsd@esciencecenter.nl). +::: + +To invite new maintainers, click on __"Generate invite link"__. +A link will be generated. +You can either copy this link or click on + +![Mail invite](/email-invite.png) + +to open your mail program with a preformulated email. + +### Pin software or projects + +To pin specific software or projects to the start of the respective list, click on the three dots in the upper right corner of a software or project card and click on __Pin software__ / __Pin project__: + +![Pinning a software](/pin-software.png) + +It will then be shown at the beginning of the list and decorated with stars: + +![Screenshot of pinned software](/pinned-software.png) + +If you no longer want to pin a software or project, click on the dots in the software card and click __Unpin software__ / __Unpin project__. + +### Denying affiliations + +An organisation maintainer can deny affiliations with software or projects. +To do this, open the context menu of the respective software or project, and click on __Deny affiliation__. +The entry will now be marked with a red sign: + +![Screenshot of a denied affiliation](/affiliation-denied.png) + +When the affiliation with an entry has been denied, the + +* entry will not appear in the organisation lists +* the organisation will not appear on the entry's page +* the entry will not be included in metrics of the organisation + +The denied affiliation will be visible to the organisation maintainer until the software/project maintainer removes the affiliation. + +### Add research units + +::: warning +Research units can only be added by the __primary maintainer__. +::: + +The RSD is capable of representing the organisational structure of an organisation. +The structure is represented using __Research units__. +A research unit has the same properties as an organisation and is maintained in the same manner, except for the fact that it has a parent organisation and is not listed on the organisations overview grid. + +It is possible to create several levels of nested research units. + +To create new research units, navigate to the __Research units__ in the sidebar, and click on the __+ Add__ button in the upper right corner. You will be presented with a modal: + +![Screenshot](/research-unit-modal.png) + +The RSD path (second input field) will be automatically populated while the name is ist typed, but can be adjusted afterwards. + +::: warning +You cannot edit the __RSD Path__ afterwards. +::: + +If possible, a logo and a website URL can be added as well. +These information can also be added at a later stage.