[Collaboration] Added doc for latest changes (#2965)

mnocon · julitafalcondusza · mnocon · commit 2c715f44352f · 2025-12-10T13:59:49.000+01:00
* [TMP] TODO

* Removed Clipboard API mention

* [Collaboration] Follow-up

* Before review fixes

* Added back clipboard mention

* Apply suggestions from code review

Co-authored-by: julitafalcondusza &lt;117284672+julitafalcondusza@users.noreply.github.com&gt;

* Added vale suggestion

---------

Co-authored-by: julitafalcondusza &lt;117284672+julitafalcondusza@users.noreply.github.com&gt;
diff --git a/docs/api/event_reference/collaboration_events.md b/docs/api/event_reference/collaboration_events.md
@@ -1,11 +1,15 @@
 ---
 description: Events that are triggered when working with collaborative editing feature.
 page_type: reference
+editions:
+    - lts-update
 month_change: true
 ---
 
 # Collaboration events
 
+You can use the following events to extend the [Collaborative editing LTS Update](collaborative_editing.md):
+
 ## Invitation events
 
 | Event | Dispatched by |
@@ -41,3 +45,10 @@ month_change: true
 |[LeaveSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-LeaveSessionEvent.html)|`SessionLeaveController::leaveAction()`|
 |[UpdateSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-UpdateSessionEvent.html)|[SessionService::updateSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession)|
 |[SessionPublicPreviewEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-SessionPublicPreviewEvent.html)|`SessionPublicPreviewController::previewAction()`|
+
+## User filtering events
+
+| Event | Dispatched by | Description |
+|---|---|---|
+|<nobr>[`UsersWithPermissionInfoMappedEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Event-UsersWithPermissionInfoMappedEvent.html)</nobr>|`Ibexa\Share\Permission\Mapper\`<br>`UsersWithPermissionInfoMapper` | Allows further filtering of users with permissions for Collaborative editing |
+
diff --git a/docs/content_management/collaborative_editing/collaborative_editing.md b/docs/content_management/collaborative_editing/collaborative_editing.md
@@ -15,8 +15,21 @@ Real-time collaboration syncs changes instantly and shows user avatars and color
 
 This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.
 
+## Getting started
+
 [[= cards([
 "content_management/collaborative_editing/collaborative_editing_guide",
 "content_management/collaborative_editing/configure_collaborative_editing",
-"content_management/collaborative_editing/collaborative_editing_api"
-], columns=3) =]]
+("permissions/policies#collaborative-editing", "Policies", "Learn about the available Collaborative editing policies"),
+("https://doc.ibexa.co/projects/userguide/en/4.6/content_management/collaborative_editing/"),
+], columns=2) =]]
+
+## Development
+
+[[= cards([
+"content_management/collaborative_editing/collaborative_editing_api",
+"api/event_reference/collaboration_events",
+("https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#collaborative-editing", "REST API Reference", "See the available endpoints for Collaborative editing"),
+"search/collaboration_search_reference/collaboration_criteria",
+"search/collaboration_search_reference/collaboration_sort_clauses",
+], columns=4) =]]
diff --git a/docs/content_management/collaborative_editing/collaborative_editing_api.md b/docs/content_management/collaborative_editing/collaborative_editing_api.md
@@ -44,6 +44,8 @@ You can find an existing session with [`SessionService::findSessions()`](/api/ph
 [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 70, 73) =]]
 ```
 
+To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Collaborative editing.
+
 ### Update session
 
 You can update existing invitation with [`SessionService::updateSession()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession):
@@ -147,7 +149,7 @@ You can delete an invitation with [`InvitationService::deleteInvitation()`](/api
 
 You can find an invitation with [`InvitationService::findInvitations()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_findInvitations).
 
-To learn more about the available search options, see Search Criteria and Sort Clauses for Collaborative editing.
+To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Collaborative editing.
 
 ## Example API usage
 
diff --git a/docs/content_management/collaborative_editing/collaborative_editing_guide.md b/docs/content_management/collaborative_editing/collaborative_editing_guide.md
@@ -19,7 +19,7 @@ The system automatically tracks changes, allowing seamless collaboration within
 ## Availability
 
 Collaborative editing is available in all [[= product_name =]] editions.
-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.
+To use Real-time editing feature, you must make arrangements with [[= product_name_base =]], and accept Terms and Conditions and Service Level Agreement in the Support Portal.
 
 ## Prerequisites
 
@@ -47,13 +47,17 @@ Collaboration session begins when first invited user accepts the invitation and
 
 To start collaborative editing, you need to invite collaborators using the **Share** button.
 
-You can invite other users to join the session, both internal and external:
+The owner of the draft can invite other users to join the session, both internal and external:
 
 - **Internal** - by searching their name or email address. These users can either edit the content item or preview it, depending on your choice.
 - **External** - by providing their email address in the field. They can only preview the content item.
 
 Once they accept the invitation, they are able to join you in editing content item or reviewing it.
 
+Once the invitation is accepted, internal users can invite further users if their permissions allow for it.
+To do so, they must be a part of an active collaboration session.
+Gaining access to the draft through other methods, for example by [workflow](workflow.md), doesn't allow you to invite other users.
+
 ![Collaborative editing - invitation](img/collaboration_invitation.png)
 
 You can change the users access or remove it at any time.
@@ -88,7 +92,6 @@ Collaboration is available for the following content types with Rich Text fields
 - Article
 - Folder
 - Form
-- Product category
 - Custom content types
 
 All changes made by collaborators are automatically saved when owner publishes or saves content.
diff --git a/docs/content_management/collaborative_editing/configure_collaborative_editing.md b/docs/content_management/collaborative_editing/configure_collaborative_editing.md
@@ -95,4 +95,80 @@ The following settings are available:
 - session:
     - `public_link_enabled` - determines whether the public link is available, default value: `false`, available values: `true`, `false`
 
+
+#### `ibexa/share` configuration
+
+To share content model, you need to configure the `ibexa/share` package.
+Under `ibexa.system` [configuration key](configuration.md#configuration-files), indicate the settings:
+
+``` yaml
+ibexa:
+    system:
+        admin_group:
+            share:
+                content_type_groups:
+                    - 'Content'
+                excluded_content_types:
+                    - 'tag'
+                    - 'product_category_tag'
+```
+
+The following setting is available:
+
+- `content_type_groups` – defines groups of content types for which the **Share** button is displayed (it can still be disabled for specific content types within these groups by using the `excluded_content_types` setting)
+
+In the example configuration above, the **Share** button is displayed for any content that belongs to the `Content` group, except for `tag` and `product_category_tag` content types.
+
+You can also control which user content types can use the feature through the `ibexa.share.permission_check_context.content.user_content_type_identifiers` container parameter.
+It accepts an array of content type identifiers and the default value is `['editor']`.
+
 You can now restart you application and start working with the Collaborative editing feature.
+To add the real-time editing capabilities, continue with the instruction below.
+
+## Configure real-time editing
+
+You must have an arrangment with [[= product_name_base =]] before configuring the real-time editing.
+If you haven't already, you must also accept the Terms of Service in the [Service portal](https://support.ibexa.co/).
+
+Only then you can create a new Collaborative editing environment.
+To do it, log in to the service portal, go to your **Service Portal** and select **Create environment** (this requires the **Portal administrator** access level).
+
+Once the environment is created, you can proceed with the configuration in [[= product_name =]].
+
+Use the generated values to set the `environment_id`, `environment_secret`, and `web_socket_url` for your [repositories](repository_configuration.md) as in the example below:
+
+``` yaml
+ibexa:
+    repositories:
+        default:
+            fieldtype_richtext_rte:
+                environment_id: '%env(CKEDITOR_ENVIRONMENT_ID)%'
+                environment_secret: '%env(CKEDITOR_ENVIRONMENT_SECRET)%'
+                web_socket_url: '%env(CKEDITOR_WEB_SOCKET_URL)%'
+```
+
+Then, enable real-time editing for specific [SiteAccesses](siteaccess.md).
+The following example enables it for the back office:
+
+``` yaml
+ibexa:
+    system:
+        admin_group:
+            fieldtype_richtext_rte:
+                enabled: true
+```
+
+Finish the configuration by running:
+
+``` bash
+composer run post-install-cmd
+```
+
+## Accepting new Terms of Service
+
+Real-Time Collaboration service is only available after accepting its Terms and Conditions.
+Any new version of this document released by [[= product_name_base =]] must be accepted before the assigned deadline.
+
+The **Portal administrator** for your [Service portal](https://support.ibexa.co) can accept it in Service portal's service details.
+
+If not done in time, the Real-Time Collaboration service will be disabled until the latest Terms and Conditions are accepted.
diff --git a/docs/permissions/limitation_reference.md b/docs/permissions/limitation_reference.md
@@ -63,7 +63,47 @@ The Change Owner (`ChangeOwner`) limitation specifies whether the user can chang
 |------|------|------|
 |`1`|"Forbid"|The user cannot change owner of a content item|
 
-## Discount Owner limitation [[% include 'snippets/commerce_badge.md' %]]
+## Collaborative editing limitations [[% include 'snippets/lts-update_badge.md' %]]
+
+The Collaborative editing limitations specify how the user can use the [Collaborative editing](collaborative_editing.md) LTS Update.
+
+### Collaborative editing Owner limitation
+
+The Owner limitation specifies whose drafts the user can share.
+If not specified, user can share:
+
+- their drafts
+- drafts they have been invited to collaborate on
+
+#### Possible values
+
+|Value|UI value|Description|
+|------|------|------|
+|"self"|"self"| User can only share drafts that they own |
+
+### Collaborative editing Scope limitation
+
+The Scope limitation specifies whether the user can share the preview and editing view with other users.
+
+#### Possible values
+
+|Value|UI value|Description|
+|------|------|------|
+|"edit"|"Edit"| User can invite other users to edit|
+|"view"|"View"| User can share the preview with other users|
+
+### Collaborative editing PublicLink limitation
+
+The Public Link (`PublicLink`) limitation specifies whether the user can manage the settings of the shareable preview link.
+
+#### Possible values
+
+|Value|UI value|Description|
+|------|------|------|
+|"Off"|"off"| User can't manage the settings|
+|"On"|"on"| User can manage the settings|
+
+## Discount Owner limitation [[% include 'snippets/lts-update_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
 
 The Discount Owner (`DiscountOwner`) limitation specifies whether the user can interact with a [discount](discounts.md).
 
diff --git a/docs/permissions/permission_use_cases.md b/docs/permissions/permission_use_cases.md
@@ -133,6 +133,8 @@ For example, to enable the user to edit only content in the "Design" stage and t
 - `content/edit` with `WorkflowStageLimitation` set to "Design".
 - `workflow/change_stage` with `WorkflowTransitionLimitation` set to `to_proofreading`
 
+When using the [Collaborative editing LTS Update](collaborative_editing.md), refer to the [Collaborative editing policies](policies.md#content-collaborative-editing) for guidance on editing without a strict workflow.
+
 ## Multi-file upload
 
 Creating content through multi-file upload is treated in the same way as regular creation.
diff --git a/docs/permissions/policies.md b/docs/permissions/policies.md
@@ -234,6 +234,14 @@ The discount policies decide which actions can be executed by given user or user
 |                        | <nobr>`versionremove`</nobr>      | remove archived content versions                                                                                                        | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Owner](limitation_reference.md#owner-limitation)</br>Status</br>[Location](limitation_reference.md#location-limitation)</br>[Subtree](limitation_reference.md#subtree-limitation)</br>[Object State](limitation_reference.md#object-state-limitation)                                                                                                                                                                                                                                                                                                                                                                                                                    |
 |                        | <nobr>`view_embed`</nobr>         | view content embedded in another content item (even when the User isn't allowed to view it as an individual content item)              | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Owner](limitation_reference.md#owner-limitation)</br>[Location](limitation_reference.md#location-limitation)</br>[Subtree](limitation_reference.md#subtree-limitation)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
+#### Content collaborative editing [[% include 'snippets/lts-update_badge.md' %]]
+
+| Module               | Function              | Effect                                                                   | Possible limitations |
+|----------------------|-----------------------|--------------------------------------------------------------------------|----------------------|
+| <nobr>`content`</nobr> | <nobr>`share`</nobr> | share content drafts with internal and external users through [collaborative editing](collaborative_editing.md)    |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)</br>[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)</br>[Scope](limitation_reference.md#collaborative-editing-scope-limitation)
+| <nobr>`rte`</nobr> | <nobr>`edit`</nobr> | use [Real-time editing](collaborative_editing_guide.md#real-time-editing)    |
+
+
 #### Content types
 
 | Module               | Function              | Effect                                                                   | Possible limitations |
@@ -292,6 +300,12 @@ The discount policies decide which actions can be executed by given user or user
 |                        | <nobr>`edit`</nobr>   | edit a product                              | [Product Type](limitation_reference.md#product-type-limitation)</br>[Language](limitation_reference.md#language-limitation) |
 |                        | <nobr>`view`</nobr>   | view products listed in the product catalog | [Product Type](limitation_reference.md#product-type-limitation)                                                             |
 
+#### Product collaborative editing [[% include 'snippets/lts-update_badge.md' %]]
+
+| Module               | Function              | Effect                                                                   | Possible limitations |
+|----------------------|-----------------------|--------------------------------------------------------------------------|----------------------|
+| <nobr>`product`</nobr> | <nobr>`share`</nobr> | share products with internal and external users through [collaborative editing](collaborative_editing.md)    |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)</br>[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)</br>[Scope](limitation_reference.md#collaborative-editing-scope-limitation) |
+
 #### Product types
 
 | Module                      | Function              | Effect                                                                                                          | Possible limitations |
diff --git a/docs/search/collaboration_search_reference/collaboration_criteria.md b/docs/search/collaboration_search_reference/collaboration_criteria.md
@@ -1,10 +1,14 @@
 ---
 month_change: true
+description: Search Criteria available for Collaboration search
+editions:
+    - lts-update
 ---
 
 # Collaboration Search Criterion reference
 
 Search Criteria are found in the `Ibexa\Contracts\Collaboration\Invitation\Query\Criterion` namespace.
+Use them to work with objects related to [Collaborative editing API](collaborative_editing_api.md).
 
 ## Invitation Search Criteria
 
diff --git a/docs/search/collaboration_search_reference/collaboration_sort_clauses.md b/docs/search/collaboration_search_reference/collaboration_sort_clauses.md
@@ -1,10 +1,14 @@
 ---
 month_change: true
+description: Sort Clauses available for Collaboration search
+editions:
+    - lts-update
 ---
 
 # Collaboration Search Sort Clauses reference
 
 Sort Clauses are found in the [`Ibexa\Contracts\Collaboration\Value\Query\SortClause`](/api/php_api/php_api_reference/namespaces/ibexa-contracts-collaboration-invitation-query-sortclause.html) namespace.
+Use them to work with objects related to [Collaborative editing API](collaborative_editing_api.md).
 
 ## Invitation Search Sort Clauses
 
