Skip to content

[Collaboration] Latest doc changes #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 4.6
Choose a base branch
from
Open

[Collaboration] Latest doc changes #381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions docs/content_management/collaborative_editing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,10 @@

Then, in a pop-up window, you can invite users to newly created session.

!!! note
You can only invite users with permissions to access the shared content.
Once invited, they might be able

Check warning on line 30 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L30 

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output 
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 30, "column": 33}}}, "severity": "WARNING"}
Users without permissions are grayed out and you can't select them and invite them to the session.

Only the owner can invite other users and initiate collaboration session.
You can only invite users with Collaboration permissions to access the shared content.
Users without permissions are grayed out and you can't select them and invite them to the session.

You can invite two types of users:

Expand All @@ -50,10 +49,12 @@

![Change access](img/change_access.png)

Additionally, you can share a direct link to the collaborative session.
Additionally, you can share a direct link to the collaborative session without specyfing a particular user.
To do it, click the **Copy link** button.
Link is copied to the clipboard and you can share it with the users through communication channels.

Use the **Link settings** button to control whether an account in the system is needed to preview content when using the direct link.

After inviting users to a collaboration session, they receive a notification:

- visible when clicking the **Notification** icon on the main dashboard (internal users)
Expand Down Expand Up @@ -99,6 +100,15 @@

![Participants list](img/participants_list.png)

#### Real-time collaboration Terms of Service changes

Real-Time Collaboration service is only available after accepting its Terms and Conditions.
When Ibexa releases a new version of this document, you will see a notification in content edit forms that the new version must be accepted before the appointed deadline.

Check failure on line 106 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L106 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 106, "column": 6}}}, "severity": "ERROR"}

Check warning on line 106 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L106 

[Ibexa.FutureTense] Use present tense instead of future.
Raw output 
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 106, "column": 57}}}, "severity": "WARNING"}

If not done in that time, the Real-Time Collaboration service will be disabled until the latest Terms and Conditions are accepted.

Check warning on line 108 in docs/content_management/collaborative_editing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/collaborative_editing.md#L108 

[Ibexa.FutureTense] Use present tense instead of future.
Raw output 
{"message": "[Ibexa.FutureTense] Use present tense instead of future.", "location": {"path": "docs/content_management/collaborative_editing.md", "range": {"start": {"line": 108, "column": 63}}}, "severity": "WARNING"}

To proceed with accepting the new version, contact your [[= product_name =]] implementation partner.

## Editing content item

Collaborative editing is enabled in Rich Text fields.
Expand All @@ -109,7 +119,6 @@
- Article
- Folder
- Form
- Product category
- Custom content types

There are two modes of the collaboration:
Expand Down Expand Up @@ -141,4 +150,4 @@

From the dashboard, you can share drafts or join collaboration session for selected content draft.

![Dashboard block - My content - new tabs](img/my_content_tabs.png)
![Dashboard block - My content - new tabs](img/my_content_tabs.png)