Skip to content

Commit 165d46d

Browse files
fixes after review
1 parent e6796d1 commit 165d46d

File tree

1 file changed

+46
-36
lines changed

1 file changed

+46
-36
lines changed

docs/content_management/collaborative_editing.md

Lines changed: 46 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@ description: Learn about Collaborative editing feature and its capabilities.
44

55
# Collaborative editing
66

7-
Collaborative editing is a feature that allows multiple users to work on the same content item at the same time.
8-
The system automatically tracks changes and allows users to collaborate within a single application, without the need for third-party tools.
9-
Users can work together and use a real-time editor to create and review content live.
10-
This makes teamwork faster, more efficient, and simplifies content review process.
11-
It allows to work directly with members of other teams, such as subject matter experts, compliance professionals, and sales representatives, to increase content quality.
7+
Collaborative editing is a feature that allows multiple users to work on the same content or product - whether to preview, review, or edit it.
8+
By giving users access to preview the content before it's published, review and collaboration becomes much easier.
9+
An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels.
10+
It improves collaboration with members of other teams, such as subject matter experts, compliance professionals, and sales representatives, to increase content quality.
11+
12+
A more advanced part of the collaboration feature is the Real-time editing.
13+
Users can edit and review content in real time, making teamwork faster, more efficient, and streamlining the content review process.
14+
The system automatically tracks changes, allowing seamless collaboration within a single content item.
1215

1316
## Collaboration session
1417

15-
When you create a new draft of 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/).
18+
When you create a new draft of content item you can invite other users to join a collaboration session.
1619

1720
To invite collaborators, click the **Share** button, which creates a new collaboration session.
1821

@@ -22,8 +25,8 @@ Then, in a pop-up window, you can invite users to newly created session.
2225

2326
!!! note
2427

25-
Only the Owner can invite other users and initiate collaboration session.
26-
You can only invite users with permissions.
28+
Only the owner can invite other users and initiate collaboration session.
29+
You can only invite users with Collaboration permissions to access the shared content.
2730
Users without permissions are grayed out and you can't select them and invite them to the session.
2831

2932
You can invite two types of users:
@@ -32,10 +35,12 @@ You can invite two types of users:
3235

3336
![Internal users - invitation](img/invite_internal_user.png)
3437

35-
- **External** - by providing their email address in the field. They can only preview the content item (editing option isn't available, it's greyed out).
38+
- **External** - by providing their email address in the field. They can only preview the content item (editing option isn't available, it's grayed out).
3639

3740
![External users - invitation](img/invite_external_user.png)
3841

42+
To confirm the provided email address, press the **Enter** key on your keyboard.
43+
3944
After inviting the user by clicking the **Invite** button, they appear in the *People with access* list.
4045
In the same pop-up window, you can change the type of access for specific user, for example, by granting them the ability to preview the content, or remove access.
4146
To do it, click the **Arrow symbol** and select the option from the list.
@@ -53,7 +58,7 @@ After inviting users to a collaboration session, they receive a notification:
5358

5459
![Notification - internal user](img/internal_notification.png)
5560

56-
Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the Owner performs one of the action:
61+
Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the owner performs one of the action:
5762

5863
- save and close
5964
- publish the content (including "Publish later" option)
@@ -64,10 +69,33 @@ Collaboration session begins when first invited user accepts the invitation and
6469

6570
Each user can leave collaboration session anytime or rejoin it.
6671

72+
### Real-time collaboration
73+
74+
Real-time collaboration is an advanced option of the Collaborative editing 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+
78+
Users can edit the content or product only if an administrator gives them the necessary permissions.
79+
These permissions must be set before the user is invited to the session, otherwise the **Edit** access option is unavailable (grayed out).
80+
81+
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.
82+
83+
![Collaboration - users tags](img/users_tags.png)
84+
85+
This allows other users in the same session, who are working the same content, to see what each person is editing in real time.
86+
87+
You can see all users belonging to a given content item's collaboration session.
88+
All users avatars are displayed at the top of the content item editing window, also in distraction free mode.
89+
90+
When you hover over the user avatar, the user’s first and last name is displayed.
91+
If you want to see all participants list, click at the avatars group.
92+
93+
![Participants list](img/participants_list.png)
94+
6795
## Editing content item
6896

6997
Collaborative editing is enabled in Rich Text fields.
70-
Other fields are disabled and can be only edited by the Owner of the content item.
98+
Other fields are disabled and can be only edited by the owner of the content item.
7199

72100
Collaboration is available for the following content types containing Rich Text fields:
73101

@@ -76,37 +104,19 @@ Collaboration is available for the following content types containing Rich Text
76104
- Form
77105
- Product category
78106
- Custom content types
79-
- Product (without variants)
107+
- Custom product types (without variants)
80108

81109
There are two modes of the collaboration:
82110

83111
- **Real-time (online)** - editing content at the same time with real-time tracking of the presence and changes of other users
84-
- **Asynchronous** - ediitng content in different time, saving changes as new version
85-
86-
Only the Owner can publish content, save it, delete the draft, or publish it.
87-
Changes are automatically saved when the Owner saves or publishes the content.
88-
Users can continue collaboration without the Owner presence, but they cannot save, or publish changes.
89-
90-
### Real-time collaboration
112+
- **Asynchronous** - editing content independently
91113

92-
Real-time collaboration is a premium feature thtat works by syncing changes in real time, so everyone can see updates instantly.
93-
Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode.
94-
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.
95-
96-
![Collaboration - users tags](img/users_tags.png)
114+
!!! warning
97115

98-
Thanks to this, other users in the same session and editing the same piece of the content item at the same time, can see the actions and editing elements performed by a specific user.
99-
100-
You can see all users belonging to a given content item's collaboration session.
101-
All users avatars are displayed:
102-
103-
- at the top of the content item editing window
104-
- in distraction free mode
105-
106-
When you hover over the user avatar, the user’s first and last name is displayed.
107-
If you want to see all participants list, click at the avatars group.
108-
109-
![Participants list](img/participants_list.png)
116+
Only the owner can publish content, save it, delete the draft, or publish it.
117+
Changes are automatically saved when the owner saves or publishes the content.
118+
Users can continue collaboration without the owner presence, but they cannot save, or publish changes.
119+
They can also leave collaboration session any time without losing data.
110120

111121
## Work with draft
112122

0 commit comments

Comments
 (0)