[Collaboration] Added doc for latest changes #2965

mnocon · 2025-12-01T13:03:14Z

~~Removed Clipboard API mention after https://github.com/ibexa/share/pull/154~~ - update: not in scope for this release
Added missing LTS Update badges
Reorganized main card page to add missing pages
Added event added in https://github.com/ibexa/share/pull/107
Added description for setting up RTE
Described the workflow when RTE T&C change
Added policies and limitations

User doc PR: ibexa/documentation-user#381

github-actions · 2025-12-01T13:13:06Z

Preview of modified files

Preview of modified Markdown:

julitafalcondusza

Please check my comments.

julitafalcondusza · 2025-12-04T12:29:23Z

docs/content_management/collaborative_editing/install_collaborative_editing.md

+
+## Configure real-time editing
+
+You must have an arrangment with Ibexa before configuring the real-time editing.


As suggested also by vale:

Suggested change

You must have an arrangment with Ibexa before configuring the real-time editing.

You must have an arrangment with [[= product_name_base =]] before configuring the real-time editing.

julitafalcondusza · 2025-12-04T12:34:41Z

docs/permissions/permission_use_cases.md

 - `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), see the [collaborative editing policies](policies.md#content-collaborative-editing) for collaborative editing without defining a strict workflow.


This sentence sounds a bit unclear, maybe something like:

Suggested change

When using the [Collaborative editing LTS Update](collaborative_editing.md), see the [collaborative editing policies](policies.md#content-collaborative-editing) for collaborative editing without defining a strict workflow.

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.

julitafalcondusza · 2025-12-04T12:37:41Z

docs/content_management/collaborative_editing/collaborative_editing.md


 This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.

+##  Getting Started


Suggested change

## Getting Started

## Getting started

julitafalcondusza · 2025-12-04T12:39:28Z

docs/api/event_reference/collaboration_events.md


 # Collaboration events

+You can use the following events to extend the [collaborative editing](collaborative_editing.md) feature:


Question: feature or LTS update aa it is for 4.6?

Also, for the consistency:

Suggested change

You can use the following events to extend the [collaborative editing](collaborative_editing.md) feature:

You can use the following events to extend the [Collaborative editing](collaborative_editing.md) feature:

julitafalcondusza · 2025-12-04T12:39:43Z

docs/api/event_reference/collaboration_events.md

+
+| 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 |


Suggested change

|[`UsersWithPermissionInfoMappedEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Event-UsersWithPermissionInfoMappedEvent.html)|`Ibexa\Share\Permission\Mapper\` `UsersWithPermissionInfoMapper` | Allows further filtering of users with permissions for collaborative editing |

|[`UsersWithPermissionInfoMappedEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Event-UsersWithPermissionInfoMappedEvent.html)|`Ibexa\Share\Permission\Mapper\` `UsersWithPermissionInfoMapper` | Allows further filtering of users with permissions for Collaborative editing |

julitafalcondusza · 2025-12-04T12:53:53Z

docs/content_management/collaborative_editing/install_collaborative_editing.md

+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, go to your Service Portal and select **Create environment** (this requires the **Portal administrator** access level).


'Your' sounds weird here:

Suggested change

To do it, go to your Service Portal and select **Create environment** (this requires the **Portal administrator** access level).

To do it, go to the Service Portal and select **Create environment** (this requires the **Portal administrator** access level).

julitafalcondusza · 2025-12-04T12:54:47Z

docs/content_management/collaborative_editing/install_collaborative_editing.md

+Only then you can create a new collaborative editing environment.
+To do it, go to your Service Portal and select **Create environment** (this requires the **Portal administrator** access level).
+
+With the environment created, you can continue the configuration in [[= product_name =]].


Suggested change

With the environment created, you can continue the configuration in [[= product_name =]].

Once the environment is created, you can proceed with the configuration in [[= product_name =]].

julitafalcondusza · 2025-12-04T12:55:34Z

docs/content_management/collaborative_editing/collaborative_editing_guide.md

 Collaborative editing is an opt-in available as an LTS update starting with the v4.6.24 in all [[= product_name =]] editions.
 To start using Collaborative editing, you must first install the required packages and perform initial configuration.
-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 & Conditions and Service Level Agreement in the Service Portal.


Suggested change

To use Real-time editing feature, you must make arrangements with [[= product_name_base =]], and accept Terms & Conditions and Service Level Agreement in the Service 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 Service Portal.

julitafalcondusza · 2025-12-04T12:56:03Z

docs/content_management/collaborative_editing/install_collaborative_editing.md

+## Accepting new Terms of Service
+
+Real-Time Collaboration service is only available after accepting its Terms and Conditions.
+When Ibexa releases a new version of this document, the new version must be accepted before the appointed deadline.


Suggested change

When Ibexa releases a new version of this document, the new version must be accepted before the appointed deadline.

Any new version of this document released by [[= product_name_base =]] must be accepted before the assigned deadline.

julitafalcondusza · 2025-12-04T12:57:08Z

docs/content_management/collaborative_editing/install_collaborative_editing.md

+Real-Time Collaboration service is only available after accepting its Terms and Conditions.
+When Ibexa releases a new version of this document, the new version must be accepted before the appointed deadline.
+
+The **Portal administrator** for your [Service portal](https://support.ibexa.co) can accept it in Service portal's service details.


Suggested change

The **Portal administrator** for your [Service portal](https://support.ibexa.co) can accept it in Service portal's service details.

The **Portal administrator** for the [Service portal](https://support.ibexa.co) can accept it in Service portal's service details.

mnocon · 2025-12-04T13:04:33Z

docs/api/event_reference/collaboration_events.md


 # Collaboration events

+You can use the following events to extend the [collaborative editing](collaborative_editing.md) feature:


Suggested change

You can use the following events to extend the [collaborative editing](collaborative_editing.md) feature:

You can use the following events to extend the [Collaborative editing LTS Update](collaborative_editing.md):

Let's go with LTS update (I will change that when merging to 5.0)

mnocon added 3 commits November 25, 2025 13:01

[TMP] TODO

307050f

Removed Clipboard API mention

c2ffbc7

[Collaboration] Follow-up

83da25f

mnocon changed the title ~~Collaboration follow up~~ [Collaboration] Added doc for latest changes Dec 1, 2025

Before review fixes

2b31cda

mnocon mentioned this pull request Dec 2, 2025

[Collaboration] Latest doc changes ibexa/documentation-user#381

Open

mnocon marked this pull request as ready for review December 2, 2025 08:02

mnocon requested a review from ciastektk December 2, 2025 08:02

mnocon added the Needs DEV review label Dec 2, 2025

mnocon requested a review from mateuszbieniek December 2, 2025 11:41

Added back clipboard mention

4e18cd7

Steveb-p approved these changes Dec 3, 2025

View reviewed changes

mnocon added the Needs DOC review label Dec 4, 2025

mnocon requested a review from a team December 4, 2025 08:54

ibexa-workflow-automation-1 bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team December 4, 2025 08:54

konradoboza approved these changes Dec 4, 2025

View reviewed changes

mnocon removed the Needs DEV review label Dec 4, 2025

julitafalcondusza requested changes Dec 4, 2025

View reviewed changes

mnocon commented Dec 4, 2025

View reviewed changes


		## Configure real-time editing

		You must have an arrangment with Ibexa before configuring the real-time editing.

	You must have an arrangment with Ibexa before configuring the real-time editing.
	You must have an arrangment with [[= product_name_base =]] before configuring the real-time editing.

	When using the [Collaborative editing LTS Update](collaborative_editing.md), see the [collaborative editing policies](policies.md#content-collaborative-editing) for collaborative editing without defining a strict workflow.
	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.


		This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.

		## Getting Started


		# Collaboration events

		You can use the following events to extend the [collaborative editing](collaborative_editing.md) feature:

	\|<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 \|
	\|<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 \|

	To do it, go to your Service Portal and select Create environment (this requires the Portal administrator access level).
	To do it, go to the Service Portal and select Create environment (this requires the Portal administrator access level).

	With the environment created, you can continue the configuration in [[= product_name =]].
	Once the environment is created, you can proceed with the configuration in [[= product_name =]].

	To use Real-time editing feature, you must make arrangements with [[= product_name_base =]], and accept Terms & Conditions and Service Level Agreement in the Service 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 Service Portal.

	When Ibexa releases a new version of this document, the new version must be accepted before the appointed deadline.
	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.
	The Portal administrator for the [Service portal](https://support.ibexa.co) can accept it in Service portal's service details.

[Collaboration] Added doc for latest changes #2965

Are you sure you want to change the base?

[Collaboration] Added doc for latest changes #2965

Uh oh!

Conversation

mnocon commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 1, 2025

Preview of modified files

Uh oh!

julitafalcondusza left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mnocon commented Dec 1, 2025 •

edited

Loading