manager-ui icon indicating copy to clipboard operation
manager-ui copied to clipboard

Content: Comments

Open zcolah opened this issue 1 year ago • 1 comments

Intro

Users will now be able to add comments to individual fields of a Content Item. This will help organizations collaborate better and have faster content workflows and conversations about updates to make to content items.

image

Feature Set

In the initial version of the commenting system users will be able to:

  1. Create a Comment.
    1. The comments should allow: Hyperlinks, Bold, Italics, Mentions
    2. The database should support rich text content (for the future). In the future we may want to allow users to: Underline, Add Images
    3. When a comment is created we want to notify via email:
  2. Delete a Comment
    1. If the user deletes a comment, the replies to it are also deleted
  3. Resolve a Comment
    1. Resolved comments will still be visible in the system. They will only not be highlighted in orange as they have been resolved.
  4. Reply to a Comment in a Comment Thread
    1. Similar to Slack/Google Docs comment threads.
    2. There is no multi level nested replies.
    3. When a reply is created, we want to notify via email
      1. Anyone who has participated and joined the comment thread
        1. The creator
        2. Anyone who has replied after
  5. Mention a User in a Comment or a Reply
    1. The user who is mentioned in the comment will receive an email about the same
    2. Only a user who has access to the instance can be mentioned and will receive the email. They will only not be able to view the item if they do not have access to it and will see that in the UI. They can then reach out to their admin and request access.
  6. Edit a Comment or a Reply
    1. This includes adding/removing mentions and text content
    2. There is no expectation that a notification email is sent when an edit is made
  7. View a Comment on a Field
    1. They should be able to see how many replies are present on the item
  8. View all Comments in a Global Comment Hub
  9. Copy a link to a Comment Thread which they can share on a 3rd party platform like Slack
  10. Receive an Email that they were mentioned in a comment or a reply
    1. We can show the comment text and the resource details and put a link to resource.
  11. Receive an Email that a content item they created has a new comment on it
    1. We can show the comment text and the resource details and put a link to resource.

Final PRD

https://doc.clickup.com/20654803/d/h/kpapk-1171/79ff855ae886938/kpapk-15671

Figma

https://www.figma.com/file/6TyAXXvHmF3zunsmUn8Ji1/Comments?type=design&node-id=0%3A1&mode=dev&t=wYOethvZkHe5wEPJ-1

zcolah avatar Jan 22 '24 23:01 zcolah

@ardeay @zcolah @shrunyan Initial backend tech spec for the commenting system: https://docs.google.com/document/d/19oGzo231ciOdYrLllSOcTpAlDtfbZnt8eJjrqQUlLRs/edit?usp=sharing

markelmad avatar Feb 28 '24 16:02 markelmad