Content
View differences
Updated by Parimal Satyal about 1 year ago
* Administration: there are new role permissions:
* View internal comments
* Write internal comments
* Edit own internal comments
* Edit others' internal comments (for moderation)
* When I write a comment, I can choose to make it internal
* There is a checkbox to enable this
* There is a "More info" button that takes the user to the documentation of the feature.
* The background colour of the comment box will change the to same colour as top info line of Internal comments in the Activity stream to reassure the user that this mode is indeed active with a clear visual signal.
* [Primer colours](https://primer.style/foundations/color/base-scales) to use:
* **Background info line:** `display-brown-bgColor-muted`
* **Background body**: `bgColor-default`
* **Text:** `fgColor-default`
* **Outline:** `display-brown-borderColor-emphasis`
* These colours will automatically adjust to dark mode (Primer feature)
* If a comment is internal, it is easily distinguishable from other comments (that are public) so I can be reassured that they can't be publicly visible.
* Internal comments appear in a different colour scheme (defined above)
* There is a lock icon on the top right corner to the left of the More icon.
* There is an alt text: "Only visible to a limited group of members."
* _This will eventually show a Primer tooltip and lead to the Members page on click. See out of scope._
* If there is also an unread badge, this will appear to the _left_ of the lock icon
* Normal (public) comments with _not_ have an unlocked icon
* Quoting is possible. However, when quoting a internal comment, that comment must also be confidential by default
* The 'Internal comment' checkbox is checked
* _Risk: the user inadvertently some how unchecks this but leaks the comment. But they could just also well copy/paste a internal comment._
* This is to limit the risk of accidental/inadvertent leaking of the comment.
* Notifications: internal comments will also appear in the notification center just like comments if I have access to them
* Same with email notifications
* It should not be possible to _@mention_ users who will not be able to view the internal comment (i.e, the drop-down needs to exclude users without the requisite permissions)
* If a user who does not have the permissions to view Internal comments is mentioned in a regular comment and the 'Internal comment' checkbox is _then_ checked, the @mention is turned into plain text.
* Unchecking the "Internal comment" checkbox will _not_ re-convert previously stripped @mentions back to links.
* If were part of a role that afforded you the ability to view internal comments and you are subsequently removed from this role such that you no longer have this permission:
* You can no longer view or post such comments in the Activity tab
* The Notification centre should not break (because it can no longer find the missing notification)
* The notifications will stop, but for unread and past notifications:
* Internal comments are now hidden
* No other changes (to # of notifications, badges...)
* _Risk: Any email notification sent cannot obviously be retracted._
* There is no visible numbering of activity comments anymore for all comments (internal or otherwise),
* Ideally, old links with `#activity-<comment-number>` still work.
* Copying the URL of a comment will have a new URL scheme including a real, persistent ID and not a generated number anymore so that it stays the same even when other comments are added or removed from the activity, e.g. #comment-<journal-id>
* When that URL is opened the browser will auto-scroll to have the comment in the visible viewport.
* When there is not Enterprise token, or the token does not allow this feature:
* We still show the permissions in the role administration and leave them editable.
* We don't show the toggle/checkbox to make a new comment a internal comment.
* We show a banner at the project setting for enabling the feature.
* internal comments can be enabed/disabled at a project level
* There will be in a new tab called 'Internal comments' 'Activity' in the new consolidated 'Work packages' page in Project settings.
* In this tab, there is a single checkbox with:
* Label: "Enable internal comments"
* Caption: "Internal "internal comments allow an internal team to communicate amongst themselves privately. These are only visible to select roles that have the necessary permissions and will not be visible publicly. Read more."
* The "Read more" is a link that links to the documentation for this feature.
<br>
**Mobile specificities**
* On narrow screens, internal comments on the timeline are displayed the same way as the mobile rendering of normal comments, but with the additional elements:
* Different background colours
* The lock icon
* When writing a comment, the "Internal comment" action uses the same string, but the 'Read 'Reed more' link is hidden
**Permissions and visibility considerations**
* The 'Last updated' field will be updated when an internal comment is posted; even users who do _not_ have the permissions to view them will see that something has changed, but will be unable to see what that is.
* Relevant: ##62473
* It is important the visibility of Internal comments is also permission-controlled in other places where Activity is reported:
* Project activity
* User activity
**Translation considerations**
* Action: "Internal comment"
* DE: ""
* FR: "Commentaire interne"
* ES: ""
* Feature name: "Internal comments"
* DE: ""
* FR: "Commentaires internes"
* ES: ""
* Permission: "View internal comments"
* DE: ""
* FR: "Lire des commentaires internes"
* ES: ""
* View internal comments
* Write internal comments
* Edit own internal comments
* Edit others' internal comments (for moderation)
* When I write a comment, I can choose to make it internal
* There is a checkbox to enable this
* There is a "More info" button that takes the user to the documentation of the feature.
* The background colour of the comment box will change the to same colour as top info line of Internal comments in the Activity stream to reassure the user that this mode is indeed active with a clear visual signal.
* [Primer colours](https://primer.style/foundations/color/base-scales) to use:
* **Background info line:** `display-brown-bgColor-muted`
* **Background body**: `bgColor-default`
* **Text:** `fgColor-default`
* **Outline:** `display-brown-borderColor-emphasis`
* These colours will automatically adjust to dark mode (Primer feature)
* If a comment is internal, it is easily distinguishable from other comments (that are public) so I can be reassured that they can't be publicly visible.
* Internal comments appear in a different colour scheme (defined above)
* There is a lock icon on the top right corner to the left of the More icon.
* There is an alt text: "Only visible to a limited group of members."
* _This will eventually show a Primer tooltip and lead to the Members page on click. See out of scope._
* If there is also an unread badge, this will appear to the _left_ of the lock icon
* Normal (public) comments with _not_ have an unlocked icon
* Quoting is possible. However, when quoting a internal comment, that comment must also be confidential by default
* The 'Internal comment' checkbox is checked
* _Risk: the user inadvertently some how unchecks this but leaks the comment. But they could just also well copy/paste a internal comment._
* This is to limit the risk of accidental/inadvertent leaking of the comment.
* Notifications: internal comments will also appear in the notification center just like comments if I have access to them
* Same with email notifications
* It should not be possible to _@mention_ users who will not be able to view the internal comment (i.e, the drop-down needs to exclude users without the requisite permissions)
* If a user who does not have the permissions to view Internal comments is mentioned in a regular comment and the 'Internal comment' checkbox is _then_ checked, the @mention is turned into plain text.
* Unchecking the "Internal comment" checkbox will _not_ re-convert previously stripped @mentions back to links.
* If were part of a role that afforded you the ability to view internal comments and you are subsequently removed from this role such that you no longer have this permission:
* You can no longer view or post such comments in the Activity tab
* The Notification centre should not break (because it can no longer find the missing notification)
* The notifications will stop, but for unread and past notifications:
* Internal comments are now hidden
* No other changes (to # of notifications, badges...)
* _Risk: Any email notification sent cannot obviously be retracted._
* There is no visible numbering of activity comments anymore for all comments (internal or otherwise),
* Ideally, old links with `#activity-<comment-number>` still work.
* Copying the URL of a comment will have a new URL scheme including a real, persistent ID and not a generated number anymore so that it stays the same even when other comments are added or removed from the activity, e.g. #comment-<journal-id>
* When that URL is opened the browser will auto-scroll to have the comment in the visible viewport.
* When there is not Enterprise token, or the token does not allow this feature:
* We still show the permissions in the role administration and leave them editable.
* We don't show the toggle/checkbox to make a new comment a internal comment.
* We show a banner at the project setting for enabling the feature.
* internal comments can be enabed/disabled at a project level
* There will be in a new tab called 'Internal comments'
* In this tab, there is a single checkbox with:
* Label: "Enable internal comments"
* Caption: "Internal
* The "Read more" is a link that links to the documentation for this feature.
<br>
**Mobile specificities**
* On narrow screens, internal comments on the timeline are displayed the same way as the mobile rendering of normal comments, but with the additional elements:
* Different background colours
* The lock icon
* When writing a comment, the "Internal comment" action uses the same string, but the 'Read
**Permissions and visibility considerations**
* The 'Last updated' field will be updated when an internal comment is posted; even users who do _not_ have the permissions to view them will see that something has changed, but will be unable to see what that is.
* Relevant: ##62473
* It is important the visibility of Internal comments is also permission-controlled in other places where Activity is reported:
* Project activity
* User activity
**Translation considerations**
* Action: "Internal comment"
* DE: ""
* FR: "Commentaire interne"
* ES: ""
* Feature name: "Internal comments"
* DE: ""
* FR: "Commentaires internes"
* ES: ""
* Permission: "View internal comments"
* DE: ""
* FR: "Lire des commentaires internes"
* ES: ""