Discourse Shared Edits

Customization Plugin
,

AI-generated summary

Discourse Shared Edits is an experimental plugin that enables real-time collaborative editing of posts. Maintained by the Discourse team, it allows moderators (including TL4) to toggle shared edits on via the composer bar gear icon. To allow non-moderators to collaborate, the post must also be set as a Wiki. The plugin features continuous real-time saving and offers configuration options for editor mode (markdown or rich text) and commit delay.

Key features and configuration include:

  • Collaboration: Moderators can enable shared edits, and users see a ‘Done’ button indicating continuous saving.
  • Settings: Administrators can enable/disable the feature, choose between markdown or rich text editors, and set the commit delay in seconds.
  • Support: As an experimental plugin, support, bug reports, UX feedback, and feature requests should be posted in their respective categories on Meta, tagged with shared-edits 1.

In the discussion, user satonotdead highlights a use case for displaying a list of all authors to provide credits in a wiki knowledge base, referencing previous discussions on showing wiki editors 69. User putty asks for an estimate on allowing non-TL4 members to toggle shared edits, a feature listed in the TODO section. Developer sam confirms this feature has been implemented and linked the relevant pull request 71.

1
:discourse2: Summary Discourse Shared Edits allows multiple users to collaboratively edit posts in real time. This feature is default disabled and must be enabled explicitly by moderators on posts.
:hammer_and_wrench: Repository Link https://github.com/discourse/discourse-shared-edits
:open_book: Install Guide How to install plugins in Discourse

Features

Moderators (including TL4) can toggle shared edits on a topic (red) via the gear icon on the composer bar. Note that the plugin does not enable edit access per se. This means that if you want non-moderators to be able to collaboratively edit the post you must also make the post a Wiki (green, optional):

Shared Edit
Shared Edit800×600 16.6 KB

Once toggled edits are collaborative. You’ll notice the button in the bottom left is now marked ‘Done’ is it is continuously saved in real time.

image
image2627×947 53.5 KB

Configuration

  • shared edits enabled : to enable or disable the feature
  • shared edits editor mode : markdown or rich editing (mixed is not supported)
  • shared edits commit delay seconds : how many seconds before post is saved in the database as a revision.

You might like to also install this Theme Component to give you more control of the appearance of Shared Edits posts:

TODO

  • Allow non-TL4 members to turn on Shared Edits - see this :link:

This plugin was inspired by @gdpelican’s collude but is a complete re-write so it fits better into the current Discourse designs.

61 Likes
Collude - a collaborative text editor for Discourse
Shared-Edits Improvements
Revision conflict with 2 users editing a wiki post at the same time
Wikified Posts Component
Possible Race Condition when editing a post
Shared drafts are not Watched
How can I compare arbitrary revisions of a post?
Why you should use Discourse internally for your company/team instead of Slack (4 years use case)
Discourse Basic Editor
Hide topic/post
Refreshed shared edits plugin
Fast Highlight
Post Edits Two Wrenches, Two Features
Off-by-one loses latest revision
Discourse as a Conference App (in person, virtual, or hybrid)
Own-topics-only category for draft announcements?
Prevent diffing against a stale snapshot or position
68

3 posts were split to a new topic: Shared Edits plugin gives 500 errors and can lose data

69

I wonder if someone else considers it appropriate to show the list of all authors when the shared edits plugin is enabled.

Our main use case is to display credits on a common wiki knowledge base, where users can contribute to gain a badge and/or maintain a specific tier (old life-time subscribers → top tier while they maintain monthly real and low-effort engagement).

I think that fits better here, but it was requested as an addition to vanilla wiki categories:

Add overview summary of all wiki edits to revision history
List of wiki editors
Show wiki post contributors?
Shared Edits History
70

Is there any estimate when this will be worked on?

2 Likes
71

Is done :slight_smile: thanks for reminding me

5 Likes