Commenting
Commenting is a functionality designed with larger teams containing multiple content editors in mind, to promote work collaboration. You will be able to leave comments in content entries, as well as receive notifications related to the comments.
#Notifications
The Notifications menu is located in the sidebar of your Hygraph project, by the bell icon. If you have any unread notifications, a red alert with the number of notifications will display on the bell.
You will be notified whenever you are mentioned in a comment, and when a comment that you have either authored or have been mentioned in is resolved or re-opened.
To access these notifications, simply click on the Notifications menu. For each one, you have the following options:
Mark as read
orMark as unread
depending on the notification status.Delete
, which clears the notification from the notifications screen.- Click on the notification itself in order to navigate to it.
At the top of the notifications screen, you'll also find a button to Mark all as read, as well as a configuration menu to select how you'd like to receive your notifications. You can use the checkboxes in the configuration menu to select if you want to be notified about comments in the app, via email, none, or both.
Please note that notifications displayed here are from all your projects, not just the project you're currently in.
#Comments
Clicking on a notification will take you to its related comment. Comments display inside the edit view of the content entry they refer to, in the Comments sidebar.
At the top, the sidebar displays how many comments there are in the current content entry, along with a status filter to help you quickly find what you're looking for.
When you click on a notification, it will take you to the corresponding content entry, where the comment you were notified about will be highlighted.
In the Comments sidebar, you can:
- Leave a new comment: Write your comment in the text box located at the top of the Comments sidebar and click on
Post
. You can mention people as well as project roles in your comment by using@
, which will display a list of users and roles for you to select from. Mentioning people or roles may cause an alert to pop up in their notifications, and/or receive an email depending on their notifications configuration.- Assign a comment: When you're writing a new comment, you can click on the
Assign
button to assign it to a team memeber in the project. Upon clicking, a list of users will display and you can simply select one with a click.
- Assign a comment: When you're writing a new comment, you can click on the
- Use the status filter: This dropdown menu allows you to sort comments by
Open
,Resolved
, andAll
. - Reply to a specific comment: If you wish to reply to a specific comment, you can click on the + icon next to the context menu. Once saved, the comment will display as nested within the parent comment. You can click on
Show reply
to show it, or onHide reply
to hide it. - Use the context menu: Use this menu to access the following actions.
- Edit: Clicking on this option allows you to edit the contents of a comment, then click on
Post
to save it. You can only edit your own comments while they are open. This option only displays for your own comments. - Resolve / Re-open: Clicking on this option marks the comment as resolved / re-opened. The people mentioned in the comment will be notified.
- Copy link: Clicking on this option copies the link to the comment. When used, that link will lead to the comment, which will be highlighted in order to be easily found.
- Delete: Clicking on this option deletes the comment. This option only displays for your own comments.
- Edit: Clicking on this option allows you to edit the contents of a comment, then click on
The Comments sidebar will only appear in a content entry once it has already been saved for the first time. Before the first save, only the Info sidebar will be available.
#Commenting & notifications workflow
The following diagram shows a simplified workflow including 2 users collaborating through our commenting feature:
Hygraph commenting & notifications workflow