Skip to content

Commit fc5b79c

Browse files
Updates, screenshots added
1 parent eefad33 commit fc5b79c

File tree

10 files changed

+32
-5
lines changed

10 files changed

+32
-5
lines changed

docs/content_management/collaborative_editing.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,36 @@ When you create a new draft of content item you can invite other users to join a
1717
To invite collaborators, click the **Share** button, which creates a new collaboration session.
1818
Then, in a pop-up window, you can invite users to newly created session.
1919

20+
![Share button](img/share_button.png)
21+
2022
!!! note
2123

22-
Only the owner can invite other users and initiate collaboration session.
24+
Only the Owner can invite other users and initiate collaboration session.
2325
You can only invite users with permissions.
2426
Users without permissions are grayed out and you can't select them and invite them to the session.
2527

2628
You can invite two types of users:
2729

2830
- **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice.
29-
- **External** - by providing their email address in the field. They can only preview the document (editing option isn't available).
31+
32+
![Internal users - invitation](img/invite_internal_user.png)
33+
34+
- **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).
35+
36+
![External users - invitation](img/invite_external_user.png)
3037

3138
Additionally, you can share a direct link to the collaborative session.
3239
To do it, click the **Copy link** button.
3340
Link is copied to the clipboard and you can share it with the users through communication channels.
3441

3542
After inviting users to a collaboration session, they receive a notification:
43+
3644
- visible when clicking the **Notification** icon on the main dashboard (internal users)
3745
- by email (external users)
3846

39-
Collaboration session begins when first invited user aceepts the invitation and joints the session, and ends when the Owner performs one of the action:
47+
![Notification - internal user](img/internal_notification.png)
48+
49+
Collaboration session begins when first invited user accepts the invitation and joins the session, and ends when the Owner performs one of the action:
4050

4151
- save and close
4252
- publish the content (including "Publish later" option)
@@ -50,7 +60,7 @@ Each user can leave collaboration session anytime or rejoin it.
5060
## Editing content item
5161

5262
Real-time collaboration is enabled in Rich Text fields.
53-
Other fields are disabled and can be only edited by the owner of the content item.
63+
Other fields are disabled and can be only edited by the Owner of the content item.
5464

5565
Real-time collaboration is available for the following content types containing Rich Text fields:
5666

@@ -66,16 +76,20 @@ There are two modes of the collaboration:
6676
- **Real-time (online)** - editing content at the same time with real-time tracking of the presence and changes of other users
6777
- **Asynchronous** - ediitng content in different time, saving changes as new version
6878

69-
Only the owner can publish content, save it, delete the draft, or publish it.
79+
Only the Owner can publish content, save it, delete the draft, or publish it.
7080
Changes are automatically saved when the Owner saves or publishes the content.
7181
Users can continue collaboration without the Owner presence, but they cannot save, or publish changes.
7282

83+
![Owner - permissions](img/owner_permissions.png)
84+
7385
### Real-time collaboration
7486

7587
Collaborative editing feature works by syncing changes in real time, so everyone can see updates instantly.
7688
Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode.
7789
While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it.
7890

91+
![Collaboration - users tags](img/users_tags.png)
92+
7993
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.
8094

8195
You can see all users belonging to a given content item's collaboration session.
@@ -85,12 +99,25 @@ All users avatars should are displayed:
8599
- in distraction free mode
86100

87101
When you hover over the user avatar, the user’s first and last name is displayed.
102+
If you want to see all participants list, click at the avatars group.
103+
104+
![Participants list](img/participants_list.png)
105+
106+
## Work with draft
107+
108+
You can access created draft in **Content** -> **Drafts**.
109+
Here you can join your collaboration session, share with more users, edit given permissions, or delete the draft.
110+
111+
![Work with draft](img/work_with_draft.png)
88112

89113
## Dashboard blocks
90114

91115
Collaborative editing feature brings two new tabs in **My content** dashboard block:
92116

93117
- **My shared drafts** - displays all drafts with active collaborations and shared by the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared with (lists all the users who received the invitation to the collaboration session). From this tab, you can perform following actions: Share, Join, Edit
118+
119+
![Dashboard block - My shared drafts](img/my_shared_drafts.png)
120+
94121
- **Drafts shared with me** - displays all drafts with active collaborations and shared with the user. Includes following columns: Name, Content type, Modified language, Version, Modified, Shared by (displays the user who invited to join the collaboration session). From this tab, you can perform following action: Join
95122

96123
From the dashboard, you can share drafts or join collaboration session for selected content draft.
175 KB
Loading
150 KB
Loading
176 KB
Loading
159 KB
Loading
172 KB
Loading
405 KB
Loading
326 KB
Loading
144 KB
Loading
175 KB
Loading

0 commit comments

Comments
 (0)