Leave comments on someone elses pages #47

Closed
opened 2026-02-04 16:23:00 +03:00 by OVERLORD · 14 comments
Owner

Originally created by @Di2g10 on GitHub (Jan 19, 2016).

Sometimes i see documentation that may contain errors. I don't want to outwrite change the page but prompt the original submitter to check and correct if neccessary. My initial thought of how to do this is to enable some sort of commenting system that is say only viewable on however when reading but doesn't affect the flow of the document.

Originally created by @Di2g10 on GitHub (Jan 19, 2016). Sometimes i see documentation that may contain errors. I don't want to outwrite change the page but prompt the original submitter to check and correct if neccessary. My initial thought of how to do this is to enable some sort of commenting system that is say only viewable on however when reading but doesn't affect the flow of the document.
OVERLORD added the 🛠️ Enhancement label 2026-02-04 16:23:00 +03:00
Author
Owner

@AbijeetP commented on GitHub (Jun 20, 2016):

This is something that I would be interested in too. Inline comments or comments at the bottom of the page, both would be good.

@AbijeetP commented on GitHub (Jun 20, 2016): This is something that I would be interested in too. Inline comments or comments at the bottom of the page, both would be good.
Author
Owner

@bridgeyuwa commented on GitHub (Jun 21, 2016):

And these type of comments should be visible only the group of users with edit permission granted to such pages

@bridgeyuwa commented on GitHub (Jun 21, 2016): And these type of comments should be visible only the group of users with edit permission granted to such pages
Author
Owner

@ssddanbrown commented on GitHub (Jun 21, 2016):

@bridgeyuwa Could this lead to duplication of comments though? I would have thought visible to all that can view the page

@ssddanbrown commented on GitHub (Jun 21, 2016): @bridgeyuwa Could this lead to duplication of comments though? I would have thought visible to all that can view the page
Author
Owner

@bridgeyuwa commented on GitHub (Jun 21, 2016):

@ssdanbrown I Was thinking of the comment more like a notification. If its a normal comment its ok to be viewed by all user that have view permission to the page.

@bridgeyuwa commented on GitHub (Jun 21, 2016): @ssdanbrown I Was thinking of the comment more like a notification. If its a normal comment its ok to be viewed by all user that have view permission to the page.
Author
Owner

@Abijeet commented on GitHub (Aug 30, 2016):

I think the initial version of this implementation should have the following -

  • Ability to add comments via WYSIWYG editor
  • Ability to edit own comments via WYSIWYG editor
  • Ability to delete your own comments
  • Ability to link directly to a comment in the page
  • Ability to reply to a comment (upto 2 levels?)
  • Display total comments on the page summary maybe?

We might want to add the following based on popular opinion -

  • Comment change history
  • Ability for admin role user to edit others comments
  • Ability for admin role user to delete others comments

These can be tackled in the next version of comments -

  • Inline document comments where users can highlight sections of pages and comment on those.
  • Like comments

@ssddanbrown - Please let me know what you think, I'll try to take a crack at it.

@Abijeet commented on GitHub (Aug 30, 2016): I think the initial version of this implementation should have the following - - [ ] Ability to add comments via WYSIWYG editor - [ ] Ability to edit own comments via WYSIWYG editor - [ ] Ability to delete your own comments - [ ] Ability to link directly to a comment in the page - [ ] Ability to reply to a comment (upto 2 levels?) - [ ] Display total comments on the page summary maybe? We might want to add the following based on popular opinion - - Comment change history - Ability for admin role user to edit others comments - Ability for admin role user to delete others comments These can be tackled in the next version of comments - - Inline document comments where users can highlight sections of pages and comment on those. - Like comments @ssddanbrown - Please let me know what you think, I'll try to take a crack at it.
Author
Owner

@ssddanbrown commented on GitHub (Sep 12, 2016):

Hi @Abijeet, Sorry I didn't come back to you sooner.

Great list. My thoughts are that we should keep things simple to start with, There's no need for a full chat solution within BookStack. Your feature list does cover the simple base features.

I don't think there's any need for full WYSIWYG inputs, We should just keep things simple and maybe spice it up with a little markdown, Much like these GitHub comments.

@ssddanbrown commented on GitHub (Sep 12, 2016): Hi @Abijeet, Sorry I didn't come back to you sooner. Great list. My thoughts are that we should keep things simple to start with, There's no need for a full chat solution within BookStack. Your feature list does cover the simple base features. I don't think there's any need for full WYSIWYG inputs, We should just keep things simple and maybe spice it up with a little markdown, Much like these GitHub comments.
Author
Owner

@Abijeet commented on GitHub (Sep 25, 2016):

I've documented some of the implementation details here -
https://gist.github.com/Abijeet/ac2e80f473359b2860b8bb6d33f6b541

@Abijeet commented on GitHub (Sep 25, 2016): I've documented some of the implementation details here - https://gist.github.com/Abijeet/ac2e80f473359b2860b8bb6d33f6b541
Author
Owner

@ssddanbrown commented on GitHub (Sep 29, 2016):

Hi @AbijeetP, That plan looks great! The only thing I would change, on the database schema, is adding an additional field named html so we can store the comment HTML at save time without having to parse the markdown for every comment on every view. Also maybe an edited boolean field so we can display if a user has edited their original comment?

@ssddanbrown commented on GitHub (Sep 29, 2016): Hi @AbijeetP, That plan looks great! The only thing I would change, on the database schema, is adding an additional field named `html` so we can store the comment HTML at save time without having to parse the markdown for every comment on every view. Also maybe an `edited` boolean field so we can display if a user has edited their original comment?
Author
Owner

@Abijeet commented on GitHub (Sep 30, 2016):

@ssddanbrown - Thanks. I agree with your inputs, I'll update the plan.

@Abijeet commented on GitHub (Sep 30, 2016): @ssddanbrown - Thanks. I agree with your inputs, I'll update the plan.
Author
Owner

@alagu commented on GitHub (May 16, 2017):

@AbijeetP Hey Abijeet, great to see the progress in this. Is there a plan to take this to upstream?

@alagu commented on GitHub (May 16, 2017): @AbijeetP Hey Abijeet, great to see the progress in this. Is there a plan to take this to upstream?
Author
Owner

@Abijeet commented on GitHub (May 16, 2017):

@alagu - Currently working on this. I expect to be done with this by sometime around June 10th.

@Abijeet commented on GitHub (May 16, 2017): @alagu - Currently working on this. I expect to be done with this by sometime around June 10th.
Author
Owner

@Abijeet commented on GitHub (Jun 5, 2017):

An update on this,

Still working on this. Done with most of the stuff and you can check the progress here - https://github.com/BookStackApp/BookStack/pull/261

I'll soon submit the code for review by @ssddanbrown after doing manual testing. I'm not sure if I can meet the June 10th deadline I'd given earlier. Maybe a couple of weeks more.

@Abijeet commented on GitHub (Jun 5, 2017): An update on this, Still working on this. Done with most of the stuff and you can check the progress here - https://github.com/BookStackApp/BookStack/pull/261 I'll soon submit the code for review by @ssddanbrown after doing manual testing. I'm not sure if I can meet the June 10th deadline I'd given earlier. Maybe a couple of weeks more.
Author
Owner

@Abijeet commented on GitHub (Jun 13, 2017):

I'm done with the implementation on this. Have updated the merge requests with my comment. You can check the latest here - https://github.com/BookStackApp/BookStack/pull/261

@Abijeet commented on GitHub (Jun 13, 2017): I'm done with the implementation on this. Have updated the merge requests with my comment. You can check the latest here - https://github.com/BookStackApp/BookStack/pull/261
Author
Owner

@ssddanbrown commented on GitHub (Sep 9, 2017):

Happy with where this is at now. Implementation now in master, Ready for v0.18 release hopefully tomorrow.

@ssddanbrown commented on GitHub (Sep 9, 2017): Happy with where this is at now. Implementation now in master, Ready for v0.18 release hopefully tomorrow.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#47