Skip to content

Commit 69e8c06

Browse files
IBX-9819v: Collaborative editing Product Guide - v4.6 (#2900)
* Collaborative editing product guide - v4.6 * mk docs updated * fixes, mentioned in LTS update list * 'by default' added while mentioning 5 users * fixes after review
1 parent 5733e89 commit 69e8c06

File tree

5 files changed

+135
-0
lines changed

5 files changed

+135
-0
lines changed
Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
description: The Collaborative editing product guide provides a full description of the features and benefits that this LTS update brings to the clients.
3+
page_type: landing_page
4+
editions:
5+
- lts-update
6+
month_change: true
7+
---
8+
9+
# Collaborative editing product guide
10+
11+
## What is collaborative editing
12+
13+
Collaborative editing is an [LTS update](editions.md#lts-updates) that allows multiple users to work on the same content simultaneously - whether to preview, review, or edit it.
14+
By giving users access to preview the content before it's published, review and collaboration become much easier.
15+
An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels.
16+
It improves collaboration with external users, such as third-party agencies.
17+
18+
A more advanced part of the collaboration feature is the Real-time editing.
19+
Users can edit and review content in real time, making teamwork faster, more efficient, and streamlining the content review process.
20+
The system automatically tracks changes, allowing seamless collaboration within a single content item.
21+
22+
## Availability
23+
24+
Collaborative editing is an opt-in available as an LTS update starting with the v4.6.24 in all [[= product_name =]] editions.
25+
To start using Collaborative editing, you must first install the required packages and perform initial configuration.
26+
To use Real-time editing feature, you must make arrangements with [[= product_name_base =]], and accept Terms & Conditions and Service Level Agreement in the Support Portal.
27+
28+
## Prerequisites
29+
30+
To use the **Copy link** option, which allows you to copy a link to the clipboard and share it through communication channels with other users, the Clipboard API is required.
31+
As a result, this option may not work in some browsers, such as Safari.
32+
33+
## How does collaboration work
34+
35+
### Content preview
36+
37+
The basic option provided by the Collaboration feature, is the ability to preview content.
38+
This allows the user to grant preview access to logged-in users, as well as share a public link with external users.
39+
40+
You can share a direct link to the collaborative session using the **Copy link** button.
41+
Link is copied to the clipboard and you can share it with the users through communication channels.
42+
43+
### Collaboration session
44+
45+
Collaborative editing allows to work together on the same content items.
46+
This is done through a collaboration session.
47+
48+
When you create a new draft of a content item you can invite other users to join a collaboration session, thanks to [CKEditor collaboration features](https://ckeditor.com/ckeditor-5/capabilities/collaboration-features/).
49+
This action generates a unique session for that draft.
50+
Collaboration session begins when first invited user accepts the invitation and joins the session.
51+
52+
To start collaborative editing, you need to invite collaborators using the **Share** button.
53+
54+
You can invite other users to join the session, both internal and external:
55+
56+
- **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice.
57+
- **External** - by providing their email address in the field. They can only preview the content item.
58+
59+
Once they accept the invitation, they are able to join you in editing content item or reviewing it.
60+
61+
![Collaborative editing - invitation](img/collaboration_invitation.png)
62+
63+
You can change the users access or remove it at any time.
64+
65+
After inviting users to a collaboration session, they receive a notification visible on the main dashboard or by email.
66+
67+
Users can also join a collaboration session using the **Join** button:
68+
69+
- available in new tabs of the **My content** block on the dashboard - *My shared drafts* and *Drafts shared with me*
70+
- by accessing a content draft in the **Drafts** menu
71+
72+
### Real-time editing
73+
74+
Real-time editing is an advanced part of the Collaboration feature.
75+
It works by syncing changes in real time, so everyone can see updates instantly.
76+
Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode.
77+
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.
78+
79+
Everyone in the session can see each other's updates as they happen — no more switching between tools or waiting for feedback.
80+
This makes content creation and review faster, more interactive, and much easier to manage as a team.
81+
82+
Users can edit the content only if an administrator gives them the necessary permissions.
83+
These permissions must be set before the user is invited to the session, otherwise the **Edit** access option is unavailable (grayed out).
84+
85+
#### Editing content items
86+
87+
Collaborative editing is enabled in [Rich Text](rich_text.md) fields.
88+
Other fields are disabled and can be only edited by the owner of the content item.
89+
90+
Collaboration is available for the following content types with Rich Text fields:
91+
92+
- Article
93+
- Folder
94+
- Form
95+
- Product category
96+
- Custom content types
97+
98+
All changes made by collaborators are automatically saved when owner publishes or saves content.
99+
Collaborators can leave collaboration session any time without losing data.
100+
101+
## Benefits
102+
103+
### Simplified content review process
104+
105+
With preview access to the content draft, reviewers can jump in, check the content, and approve it more quickly.
106+
This streamlines the entire review cycle and minimizes delays caused by version confusion or slow feedback.
107+
Review can be done even by external users without a need to set up an account in [[= product_name =]].
108+
109+
### Cross-functional collaboration
110+
111+
Collaborative editing allows teams to involve users from across the organization.
112+
Their input can be integrated directly into the editing process, leading to more accurate and aligned content.
113+
114+
### Enhanced teamwork
115+
116+
All the users invited to the collaboration session can share ideas, make suggestions, and refine each other’s work in a shared environment, creating a stronger sense of team ownership and collaboration.
117+
118+
### Real-time collaboration
119+
120+
Collaborative editing enables multiple users to work on the same content item at the same time.
121+
Everyone in the session can see changes as they happen, which shortens the feedback loop and allows multiple people to work in parallel.
122+
123+
### Improved efficiency
124+
125+
By allowing simultaneous editing, the content creation and review process becomes significantly faster.
126+
Team members can work together and finalize content in a fraction of the time it would take with a standard workflow.
127+
128+
### Seamless feedback loop
129+
130+
Users can share and receive feedback instantly within the same editing interface.
131+
This reduces the need to switch between apps or track changes manually.
155 KB
Loading

docs/ibexa_products/editions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ The features brought by LTS Updates become standard parts of the next LTS releas
6363
| Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
6464
|-----------------|-----------------|-----------------|-----------------|
6565
| [AI Actions](ai_actions_guide.md) | ✔ | ✔ | ✔ |
66+
| [Collaborative editing](collaborative_editing_guide.md) | ✔ | ✔ | ✔ |
6667
| [Date and time attribute type](date_and_time.md) | ✔ | ✔ | ✔ |
6768
| [Discounts](discounts.md) | | | ✔ |
6869
| [Symbol attribute type](symbol_attribute_type.md) | ✔ | ✔ | ✔ |

docs/product_guides/product_guides.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Discover the primary ones with the help of product guides. Condensed content all
1616
"content_management/rich_text/online_editor_guide",
1717
"content_management/pages/page_builder_guide",
1818
"content_management/forms/form_builder_guide",
19+
"content_management/collaborative_editing/collaborative_editing_guide",
1920
"customer_management/customer_portal",
2021
"personalization/personalization_guide",
2122
"pim/pim_guide",

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,8 @@ nav:
282282
- Time field type: content_management/field_types/field_type_reference/timefield.md
283283
- URL field type: content_management/field_types/field_type_reference/urlfield.md
284284
- User field type: content_management/field_types/field_type_reference/userfield.md
285+
- Collaborative editing:
286+
- Collaborative editing product guide: content_management/collaborative_editing/collaborative_editing_guide.md
285287
- Templating:
286288
- Templating: templating/templating.md
287289
- Render content:

0 commit comments

Comments
 (0)