Skip to content

Commit

Permalink
Merge pull request #485 from BioKIC/public-feedback2
Browse files Browse the repository at this point in the history
Add documentation related to public feedback
  • Loading branch information
ljwalker committed Apr 4, 2024
2 parents 4378779 + 48266eb commit ce0c1d3
Show file tree
Hide file tree
Showing 10 changed files with 94 additions and 3 deletions.
18 changes: 18 additions & 0 deletions content/coll_manager/public_feedback/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Public Feedback"
date: 2024-04-03
lastmod: 2024-04-03
weight: 15
draft: false
authors: ["Lindsay Walker"]
keywords: ["crowdsourcing","annotations", "comments", "public feedback"]
---

{{< notice info >}}
Sourcing public feedback on your specimen occurrences is one way to improve the "cleanliness", or quality, of your data. Symbiota offers several tools to help you gather this information from anyone with a portal user account.
{{</ notice >}}
- [Commenting](/symbiota-docs/coll_manager/public_feedback/comment/)
- [Public Edits](/symbiota-docs/coll_manager/public_feedback/public_edits/)

### Related Resources
{{< youtube fCKIMYNbJ0M >}}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Comments on Records"
title: "Public Comments"
date: 2021-11-22
draft: false
weight: 5
Expand Down
File renamed without changes.
32 changes: 32 additions & 0 deletions content/coll_manager/public_feedback/public_edits/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Public Edits"
date: 2024-04-03
lastmod: 2024-04-03
weight: 15
draft: false
authors: ["Lindsay Walker"]
keywords: ["crowdsourcing","annotations", "comments", "public feedback"]
---

{{< notice info >}}
This page describes how any Symbiota user can suggest modifications to an occurrence record. This can be a useful feature for community members to remediate data quality issues.
{{</ notice >}}

### Enable Public Edits
The option to enabled public edits is managed on a **per-collection basis** and is activated through the [Collection Metadata Editor](/symbiota-docs/coll_manager/metadata/#collections_metadata). Turn this on by navigating to the _Administration Control Panel > Edit Metadata_ and check the box for _Allow Public Edits_.

Once activated, any portal user who is logged in can suggest changes to your occurrence records using a paired-down version of the Occurrence Editor form. Public users cannot suggest edits to _Catalog Number_ or _Scientific Name_ values.

| ![Public Feedback Example](/symbiota-docs/images/publicfeedback.png) |
|:--:|
| Once Public Edits are enabled via the [Collection Metadata Editor](/symbiota-docs/coll_manager/metadata/#collections_metadata), any user who is logged into the portal can suggest changes to individual occurrence records. |

### Review Public Edits

To review suggested changes made by public users:
1) Navigate to the _Administration Control Panel > Review/Verify Occurrence Edits_.
2) In the Filter panel, set _Applied Status_ = "Not Applied" and select _Submit Filter_ to filter out pending public edits to your occurence records.
3) Proceed to use the [Specimen Edit Reviewer](/symbiota-docs/coll_manager/review/) to accept and reject suggested changes to your records.

### What do public portal users see?
Refer to the [User Guide](/symbiota-docs/user/public_feedback/public_edits/) for more information.
15 changes: 15 additions & 0 deletions content/user/public_feedback/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Provide Feedback"
date: 2024-04-03
lastmod: 2024-04-03
weight: 15
draft: false
authors: ["Lindsay Walker"]
keywords: ["crowdsourcing","annotations", "comments", "public feedback"]
---

{{< notice info >}}
Providing feedback on specimen records is one way to improve the quality of data available in a given Symbiota portal. This can be accomplished by leaving comments on and suggesting edits to occurrence records in Symbiota portals.
{{</ notice >}}
- [Leave Comments](/symbiota-docs/user/public_feedback/comment/)
- [Suggest Edits](/symbiota-docs/coll_manager/public_feedback/public_edits/)
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Commenting on Records"
title: "Leave Comments"
date: 2022-01-21
authors: ["Katie Pearson"]
editors: ["Lindsay Walker"]
lastmod: 2023-12-06
lastmod: 2024-04-03
draft: false
weight: 32
keywords: ["comment","correction","contact"]
Expand Down
File renamed without changes.
26 changes: 26 additions & 0 deletions content/user/public_feedback/public_edits/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: "Suggest Edits"
date: 2024-04-03
lastmod: 2024-04-03
weight: 15
draft: false
authors: ["Lindsay Walker"]
keywords: ["crowdsourcing","annotations", "comments", "public feedback"]
---

{{< notice info >}}
This page describes how any Symbiota user can suggest modifications to an occurrence record. This can be a useful feature for community members to remediate data quality issues.
{{</ notice >}}

{{< notice note >}}
Portal users can only leave suggested edits on occurrence records if 1) they are logged into the portal and 2) public editing is enabled for a given collection.
{{</ notice >}}

To suggest changes to an occurrence record:
1) Open the occurrence record and select the link at the bottom of the record that reads, "Occurrence Editor", as in the example below.
![Public Feedback Example](/symbiota-docs/images/publicfeedback.png)

2) Open the record and make changes using the Occurrence Data form. Note that public users **cannot** make suggested changes to _Catalog Number_ or _Scientific Name_ values; use the [commenting](/symbiota-docs/user/public_feedback/comment/) tools to leave remarks related to these fields.

3) Select the "Save Edits" button at the bottom of the page once your modifications are complete. Your suggested changes will be submitted to the Collection Administrator for review before they will become public.
![Public Feedback Example](/symbiota-docs/images/publicfeedback_confirmation.png)
Binary file added static/images/publicfeedback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/publicfeedback_confirmation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce0c1d3

Please sign in to comment.