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

Add support for public commenting on posted/published content #10323

Open
asmecher opened this issue Aug 15, 2024 · 10 comments
Open

Add support for public commenting on posted/published content #10323

asmecher opened this issue Aug 15, 2024 · 10 comments
Assignees
Milestone

Comments

@asmecher
Copy link
Member

Editors wish to be able to permit public commenting on published content (articles, monographs, and preprints).

This could be achieved by:

@felixhelix
Copy link

felixhelix commented Aug 16, 2024

Hi, we developed a commenting plugin from scratch for our preprint server :)
It uses vue, tailwind and the pkp api. It is in our gitlab repo, but I see if I can get it in github within the next weeks so you can have a look at it (and/or post a link once our OPS goes public).
Currently version ops 3.3 is supported, but I already started working on a 3.5 version.
yours,
felix

@ewhanson
Copy link
Collaborator

@felixhelix, that would be great to see. Looking forward to it!

@asmecher, I also did a bit of looking into some of the Laravel packages. I haven't ever adapted an existing Laravel package to work in a non-Laravel context, but it seems like it may end up being a decent amount of work since a lot of what makes the Laravel packges easy to get up and running are the automatic binding of things in the service providers, use of the different Laravel helpers, etc. I was looking at the beyondcode/laravel-comments package, which is fairly minimal, but could be straightforward to using as a starting point for coding something from scratch.

@felixhelix
Copy link

felixhelix commented Aug 29, 2024

I just published the OPS 3.3 version of the commenting plugin to github, so you can have a look and see if this could be a way to go:

https://github.com/felixhelix/userComments

There is no release yet, but I provided some documentation for installing.
The backend is a bit clumsy, since it was originally only meant for me and my colleague to work with.

I will be at the sprint in Turin this year :)
So maybe this could be an opportunity to talk about it as well.

@asmecher asmecher added this to the 3.6 milestone Aug 29, 2024
@asmecher
Copy link
Member Author

Thanks, @felixhelix!

@ewhanson, could you take a look over this?

@Devika008
Copy link

Hello @felixhelix

Is there a recording or screenshots showing how this works?

From a UI/UX perspective, I was thinking of keeping it simple with plain text comments, without any formatting options. To identify the user, we could include their profile picture and name. I've noticed some journals offer features like liking or replying to comments, but I feel that might be a bit too much. Keeping it straightforward would be better.

@ewhanson do you need me to develop some mockups for this or would you like me to review? I think its a better idea to use @felixhelix 's plugin as starting point for this

1 similar comment
@Devika008
Copy link

Hello @felixhelix

Is there a recording or screenshots showing how this works?

From a UI/UX perspective, I was thinking of keeping it simple with plain text comments, without any formatting options. To identify the user, we could include their profile picture and name. I've noticed some journals offer features like liking or replying to comments, but I feel that might be a bit too much. Keeping it straightforward would be better.

@ewhanson do you need me to develop some mockups for this or would you like me to review? I think its a better idea to use @felixhelix 's plugin as starting point for this

@asmecher
Copy link
Member Author

The big question -- if the commenting feature is intended to serve an open review functionality -- is whether it would be best to extend the existing peer review toolkit to support an additional transparent mode. This would have several benefits -- all review content, whether open or closed, would live in the same data model. However, public peer reviews are quite different from traditional peer reviews in that there is no assign/accept/complete workflow, so much of the existing review assignment code would not be useful and might need to be made more flexible.

@Devika008
Copy link

How about we make the peer review process more interactive? If someone is interested in reviewing an article, they could click on 'Review article,' and then the page would expand to show the questions. This way, we can separate casual comments from formal reviews, keeping the space organized and easy to navigate without overwhelming users and/or editors parsing through the comments

@felixhelix
Copy link

felixhelix commented Sep 18, 2024

Hi @Devika008, we hope to go online next month. But here is a screenshot of the details page (we are currently doing usability tests, so the overall design is still in a flux):

grafik

As you see, there is a button for submitting peer reviews and below is the comment section.
So far we have no user picture, instead we provide the orcid id.

As one can see, there is a "submit a review report" button as suggested :)
This leads to a pre-configured submission wizard: Review reports are submitted as yet another manuscript, but assigned to a specific section and with submission metadata entries that link them to the manuscript under review. This is because we want to use the existing workflow for doi and orcid registration.

@ewhanson I also finished a version that works with 3.5. I am about to update some code, but if it would make it easier for you to have a look, I could push that branch too.

@Devika008
Copy link

Devika008 commented Sep 19, 2024

Hello,

@ewhanson and I had a quick discussion about this, and while we're still going over the details, I think it's best to focus on enabling public commenting for now. We can create a separate issue for the workflow of inviting open reviews since that will need more in-depth research. For public commenting, I really like @felixhelix's approach and might tweak it slightly, as shown below

image

In the 'More Options' section for admins or journal managers, we could include a 'Hide Comment' button to remove inappropriate comments. While this gives them the ability to hide any comment, another option could be to implement a 'Report' feature, where the admin sees the report and can then decide to hide it. Typically, reporting a comment involves filling out a form explaining the reason. Let me know if that feels too much or unnecessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: UX/UI In Progress
Status: No status
Development

No branches or pull requests

5 participants