diff --git a/code_samples/collaboration/src/Command/ManageSessionsCommand.php b/code_samples/collaboration/src/Command/ManageSessionsCommand.php index e0d2aa8acfd..7cd7e0d5b82 100644 --- a/code_samples/collaboration/src/Command/ManageSessionsCommand.php +++ b/code_samples/collaboration/src/Command/ManageSessionsCommand.php @@ -114,7 +114,7 @@ public function execute(InputInterface $input, OutputInterface $output): int ->getParticipants() ->getByEmail($user->email); - $internalParticipantUpdateStruct = new InternalParticipantUpdateStruct(ContentSessionScope::EDIT); + $internalParticipantUpdateStruct = new InternalParticipantUpdateStruct(ContentSessionScope::VIEW); $this->sessionService->updateParticipant($session, $participant, $internalParticipantUpdateStruct); // Remove participant diff --git a/docs/api/event_reference/collaboration_events.md b/docs/api/event_reference/collaboration_events.md index 38794591274..816db98882f 100644 --- a/docs/api/event_reference/collaboration_events.md +++ b/docs/api/event_reference/collaboration_events.md @@ -1,12 +1,12 @@ --- -description: Events that are triggered when working with collaborative editing feature. +description: Events that are triggered when working with Content sharing feature. page_type: reference month_change: false --- -# Collaboration events +# Content sharing events -You can use the following events to extend the [Collaborative editing LTS Update](collaborative_editing.md): +You can use the following events to extend the [Content sharing LTS Update](content_sharing.md): ## Invitation events @@ -48,4 +48,4 @@ You can use the following events to extend the [Collaborative editing LTS Update | Event | Dispatched by | Description | |---|---|---| -|[`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 Content sharing | diff --git a/docs/content_management/collaborative_editing/collaborative_editing.md b/docs/content_management/collaborative_editing/collaborative_editing.md deleted file mode 100644 index 24000bbb7f4..00000000000 --- a/docs/content_management/collaborative_editing/collaborative_editing.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -description: Collaborative editing enables multiple users to work on the same content simultaneously. -page_type: landing_page -editions: - - lts-update -month_change: false ---- - -# Collaborative editing - -With Collaborative editing [LTS update](editions.md#lts-updates) multiple users can work on the same content created in [[= product_name =]] simultaneously, streamlining the content creation and review process. - -Users can invite both internal and external collaborators to a session, giving them access for editing or previewing. - -Additionally, they can collaborate using a Real-time collaboration, an advanced part of the collaboration feature, to write and review content in a live mode thanks to CKEditor. -Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing specific part of the Rich Text field. - -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/install_collaborative_editing", -("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/", "Collaborative editing", "Learn about Collaborative editing feature and its capabilities."), -], 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"), -"content_management/collaborative_editing/extend_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_guide.md b/docs/content_management/collaborative_editing/collaborative_editing_guide.md deleted file mode 100644 index 4ac124eb04a..00000000000 --- a/docs/content_management/collaborative_editing/collaborative_editing_guide.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -description: The Collaborative editing product guide provides a full description of the features and benefits that this LTS update brings to the clients. -page_type: landing_page -editions: - - lts-update -month_change: false ---- - -# Collaborative editing product guide - -## What is collaborative editing - -Collaborative editing is an [LTS update](editions.md#lts-updates) that allows multiple users to work on the same content simultaneously - whether to preview, review, or edit it. -By giving users access to preview the content before it's published, review and collaboration become much easier. -An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels. -It improves collaboration with external users, such as third-party agencies. - -A more advanced part of the collaboration feature is the Real-time editing. -Users can edit and review content in real time, making teamwork faster, more efficient, and streamlining the content review process. -The system automatically tracks changes, allowing seamless collaboration within a single content item. - -## Availability - -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 and Conditions and Service Level Agreement in the Service Portal. - -## How does collaboration work - -### Content preview - -The basic option provided by the Collaboration feature, is the ability to preview content. -This allows the user to grant preview access to logged-in users, as well as share a public link with external users. - -You can share a direct link to the collaborative session using the **Copy link** button. -Link is copied to the clipboard and you can share it with the users through communication channels. - -### Collaboration session - -Collaborative editing allows to work together on the same content items. -This is done through a collaboration session. - -When you create a new draft of a 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/). -This action generates a unique session for that draft. -Collaboration session begins when first invited user accepts the invitation and joins the session. - -To start collaborative editing, you need to invite collaborators using the **Share** button. - -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. - -After inviting users to a collaboration session, they receive a notification visible on the main dashboard or by email. - -Users can also join a collaboration session using the **Join** button: - -- available in new tabs of the **My content** block on the dashboard - *My shared drafts* and *Drafts shared with me* -- by accessing a content draft in the **Drafts** menu - -### Real-time editing - -Real-time editing is an advanced part of the Collaboration feature. -It works by syncing changes in real time, so everyone can see updates instantly. -Avatars of the users invited to collaboration session are visible at the top of the editing screen, also in distraction free mode. -While editing Rich Text fields, you can see colored tracking tags with user avatar thumbnails that indicate who is currently working on it. - -Everyone in the session can see each other's updates as they happen — no more switching between tools or waiting for feedback. -This makes content creation and review faster, more interactive, and much easier to manage as a team. - -Users can edit the content only if an administrator gives them the necessary permissions. -These permissions must be set before the user is invited to the session, otherwise the **Edit** access option is unavailable (grayed out). - -#### Editing content items - -Collaborative editing is enabled in [Rich Text](rich_text.md) fields. -Other fields are disabled and can be only edited by the owner of the content item. - -Collaboration is available for the following content types with Rich Text fields: - -- Article -- Folder -- Form -- Custom content types - -All changes made by collaborators are automatically saved when owner publishes or saves content. -Collaborators can leave collaboration session any time without losing data. - -## Benefits - -### Simplified content review process - -With preview access to the content draft, reviewers can jump in, check the content, and approve it more quickly. -This streamlines the entire review cycle and minimizes delays caused by version confusion or slow feedback. -Review can be done even by external users without a need to set up an account in [[= product_name =]]. - -### Cross-functional collaboration - -Collaborative editing allows teams to involve users from across the organization. -Their input can be integrated directly into the editing process, leading to more accurate and aligned content. - -### Enhanced teamwork - -All the users invited to the collaboration session can share ideas, make suggestions, and refine each other’s work in a shared environment, creating a stronger sense of team ownership and collaboration. - -### Real-time collaboration - -Collaborative editing enables multiple users to work on the same content item at the same time. -Everyone in the session can see changes as they happen, which shortens the feedback loop and allows multiple people to work in parallel. - -### Improved efficiency - -By allowing simultaneous editing, the content creation and review process becomes significantly faster. -Team members can work together and finalize content in a fraction of the time it would take with a standard workflow. - -### Seamless feedback loop - -Users can share and receive feedback instantly within the same editing interface. -This reduces the need to switch between apps or track changes manually. diff --git a/docs/content_management/collaborative_editing/img/collaboration_invitation.png b/docs/content_management/collaborative_editing/img/collaboration_invitation.png deleted file mode 100644 index cd294673f83..00000000000 Binary files a/docs/content_management/collaborative_editing/img/collaboration_invitation.png and /dev/null differ diff --git a/docs/content_management/content_sharing/content_sharing.md b/docs/content_management/content_sharing/content_sharing.md new file mode 100644 index 00000000000..1ec400c59eb --- /dev/null +++ b/docs/content_management/content_sharing/content_sharing.md @@ -0,0 +1,35 @@ +--- +description: Content sharing enables users to share content drafts with other users for preview and review. +page_type: landing_page +editions: + - lts-update +month_change: false +--- + +# Content sharing + +With Content sharing [LTS update](editions.md#lts-updates) users can share content drafts created in [[= product_name =]] with other users, streamlining the content review process. + +Users can invite both internal and external users to a collaboration session, giving them access for previewing the draft. + +This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily. + +## Getting started + +[[= cards([ +"content_management/content_sharing/content_sharing_guide", +"content_management/content_sharing/install_content_sharing", +("permissions/policies#content-sharing", "Policies", "Learn about the available Content sharing policies"), +("https://doc.ibexa.co/projects/userguide/en/4.6/content_management/collaborative_editing/", "Content sharing", "Learn about Content sharing feature and its capabilities."), +], columns=2) =]] + +## Development + +[[= cards([ +"content_management/content_sharing/content_sharing_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 Content sharing"), +"content_management/content_sharing/extend_content_sharing", +"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/content_sharing/content_sharing_api.md similarity index 87% rename from docs/content_management/collaborative_editing/collaborative_editing_api.md rename to docs/content_management/content_sharing/content_sharing_api.md index e60f8425a88..4b9c8091ec5 100644 --- a/docs/content_management/collaborative_editing/collaborative_editing_api.md +++ b/docs/content_management/content_sharing/content_sharing_api.md @@ -1,13 +1,13 @@ --- -description: Use PHP API to manage invitations, sessions, and participants while using collaborative editing feature. +description: Use PHP API to manage invitations, sessions, and participants while using Content sharing feature. editions: - lts-update month_change: false --- -# Collaborative editing API +# Content sharing API -[[= product_name =]]'s Collaborative editing API provides two services for managing sessions and invitations, which differ in function: +[[= product_name =]]'s Content sharing API provides two services for managing sessions and invitations, which differ in function: - [`InvitationServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) is used to manage collaboration sessions invitations @@ -47,7 +47,7 @@ You can find an existing session with [`SessionService::findSessions()`](/api/ph [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 80, 82) =]] ``` -To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) 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 Content sharing. ### Update session @@ -79,20 +79,24 @@ You can add internal participants - users who already have an account in the [[= External participant can only be invited using their email address. The `ContentSessionScope::VIEW` constant defines the type of access granted to a participant. -Available scopes are: +For content collaboration sessions, `VIEW` is the only available scope. +It grants read-only access, used for preview purposes. -- `VIEW` - read-only access, used for preview purposes -- `EDIT` - grants editing capabilities +!!! caution "Deprecated `EDIT` scope" + + The `ContentSessionScope::EDIT` constant is deprecated and will be removed in [[= product_name =]] 6.0. + Adding or updating a participant of a content collaboration session with the `EDIT` scope results in an error. ### Get and update participant You can update participant added to the collaboration session with [`SessionService::updateParticipant()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant). -The example below updates participant's permissions to allow for editing of shared content, not only previewing. +The example below updates participant's scope. ``` php [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 111, 118) =]] ``` + ### Remove participant You can remove participant from the collaboration session with [`SessionService::removeParticipant()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant): @@ -132,13 +136,13 @@ You can get an invitation with [`InvitationService::getInvitation()`](/api/php_a ### Create invitation -You can create new invitation for the collaborative session using the [`InvitationService::createInvitation()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method: +You can create new invitation for the collaboration session using the [`InvitationService::createInvitation()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method: ``` php [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 145, 151) =]] ``` -You can use it when [auto-inviting participants](install_collaborative_editing.md#configuration) is not enabled. +You can use it when [auto-inviting participants](install_content_sharing.md#configuration) is not enabled. ### Update invitation @@ -164,11 +168,11 @@ You can find an invitation with [`InvitationService::findInvitations()`](/api/ph [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 135, 141) =]] ``` -To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) 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 Content sharing. ## Example API usage -Below you can see an example of API usage for Collaborative editing: +Below you can see an example of API usage for Content sharing: ``` php [[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php') =]] diff --git a/docs/content_management/content_sharing/content_sharing_guide.md b/docs/content_management/content_sharing/content_sharing_guide.md new file mode 100644 index 00000000000..5309e84c14e --- /dev/null +++ b/docs/content_management/content_sharing/content_sharing_guide.md @@ -0,0 +1,90 @@ +--- +description: The Content sharing product guide provides a full description of the features and benefits that this LTS update brings to the clients. +page_type: landing_page +editions: + - lts-update +month_change: false +--- + +# Content sharing product guide + +## What is content sharing + +Content sharing is an [LTS update](editions.md#lts-updates) that allows you to share content drafts with other users, so that they can preview and review them before publication. +By giving users access to preview the content before it's published, review and collaboration become much easier. +An additional option here is the ability to copy a link to the content item, which allows to share it through communication channels. +It improves collaboration with external users, such as third-party agencies. + +## Availability + +Content sharing is an opt-in available as an LTS update starting with the v4.6.24 in all [[= product_name =]] editions. +To start using Content sharing, you must first install the required packages and perform initial configuration. + +## How does content sharing work + +### Content preview + +The basic option provided by Content sharing is the ability to preview content. +This allows the user to grant preview access to logged-in users, as well as share a public link with external users. + +You can share a direct link to the collaboration session using the **Copy link** button. +Link is copied to the clipboard and you can share it with the users through communication channels. + +### Collaboration session + +Content sharing works through a collaboration session. + +When you create a new draft of a content item, you can invite other users to preview it. +This action generates a unique session for that draft. +Collaboration session begins when first invited user accepts the invitation and joins the session. + +To start sharing a draft, invite users with the **Share** button. + +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. +- **External** - by providing their email address in the field. + +Invited users, both internal and external, can only preview the draft. + +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. + +![Content sharing - invitation](img/collaboration_invitation.png) + +You can remove the users' access at any time. + +After inviting users to a collaboration session, they receive a notification visible on the main dashboard or by email. + +Users can also join a collaboration session using the **Join** button, available: + +- in the *My shared drafts* and *Drafts shared with me* tabs of the **My content** block on the dashboard +- in the **Drafts** menu +- in the **Versions** tab of the content item + +The **Join** button opens the preview of the draft. +The owner of the draft is taken to the editing screen instead. + +### Editing shared drafts + +Sharing a draft doesn't lock it. +Other users with permissions to edit the content item can open and edit the shared draft in the usual way, for example, from the **Drafts** menu or the **Versions** tab. +Changes aren't synchronized between users who edit the same draft at the same time, so coordinate the editing work to avoid conflicting changes. + +## Benefits + +### Simplified content review process + +With preview access to the content draft, reviewers can jump in, check the content, and approve it more quickly. +This streamlines the entire review cycle and minimizes delays caused by version confusion or slow feedback. +Review can be done even by external users without a need to set up an account in [[= product_name =]]. + +### Cross-functional collaboration + +Content sharing allows teams to involve reviewers from across the organization and beyond. +Their feedback can be taken into account before the content is published, leading to more accurate and aligned content. + +### Enhanced teamwork + +All the users invited to the collaboration session work with the same draft, which makes it easier to share ideas and suggestions, and creates a stronger sense of team ownership. diff --git a/docs/content_management/collaborative_editing/extend_collaborative_editing.md b/docs/content_management/content_sharing/extend_content_sharing.md similarity index 97% rename from docs/content_management/collaborative_editing/extend_collaborative_editing.md rename to docs/content_management/content_sharing/extend_content_sharing.md index 39c5ef28b31..f7f9348d87c 100644 --- a/docs/content_management/collaborative_editing/extend_collaborative_editing.md +++ b/docs/content_management/content_sharing/extend_content_sharing.md @@ -1,18 +1,18 @@ --- -description: Extend Collaborative editing +description: Extend Content sharing month_change: false editions: - lts-update --- -# Extend Collaborative editing +# Extend Content sharing -Thanks to the ability to extend the [Collaborative editing](collaborative_editing_guide.md) feature, you can introduce additional functionalities to enhance workflows not only in the context of content editing but also when working with products. +Thanks to the ability to extend the [Content sharing](content_sharing_guide.md) feature, you can introduce additional functionalities to enhance workflows not only in the context of content items but also when working with products. The example below demonstrates how to extend the feature to enable a shared Cart functionality in the Commerce system. !!! tip - If you prefer learning from videos, watch the Ibexa Summit 2025 presentation that covers the Collaborative editing feature: + If you prefer learning from videos, watch the Ibexa Summit 2025 presentation that covers this feature, then called Collaborative editing: [_Collaboration: greater than the sum of the parts_](https://www.youtube.com/watch?v=dRB-SDlgX0I) by Marek Nocoń diff --git a/docs/content_management/content_sharing/img/collaboration_invitation.png b/docs/content_management/content_sharing/img/collaboration_invitation.png new file mode 100644 index 00000000000..5fc93408af1 Binary files /dev/null and b/docs/content_management/content_sharing/img/collaboration_invitation.png differ diff --git a/docs/content_management/collaborative_editing/img/share_button.png b/docs/content_management/content_sharing/img/share_button.png similarity index 100% rename from docs/content_management/collaborative_editing/img/share_button.png rename to docs/content_management/content_sharing/img/share_button.png diff --git a/docs/content_management/collaborative_editing/img/share_email.png b/docs/content_management/content_sharing/img/share_email.png similarity index 100% rename from docs/content_management/collaborative_editing/img/share_email.png rename to docs/content_management/content_sharing/img/share_email.png diff --git a/docs/content_management/collaborative_editing/img/share_message.png b/docs/content_management/content_sharing/img/share_message.png similarity index 100% rename from docs/content_management/collaborative_editing/img/share_message.png rename to docs/content_management/content_sharing/img/share_message.png diff --git a/docs/content_management/collaborative_editing/install_collaborative_editing.md b/docs/content_management/content_sharing/install_content_sharing.md similarity index 60% rename from docs/content_management/collaborative_editing/install_collaborative_editing.md rename to docs/content_management/content_sharing/install_content_sharing.md index 9c69289f75f..75052cd77e2 100644 --- a/docs/content_management/collaborative_editing/install_collaborative_editing.md +++ b/docs/content_management/content_sharing/install_content_sharing.md @@ -1,13 +1,13 @@ --- -description: Install the Collaborative editing LTS update. +description: Install the Content sharing LTS update. editions: - lts-update month_change: false --- -# Install Collaborative editing +# Install Content sharing -Collaborative editing feature is available as an [LTS update](editions.md#lts-updates) to [[= product_name =]] starting with version v4.6.24 or higher, regardless of its edition. +Content sharing feature is available as an [LTS update](editions.md#lts-updates) to [[= product_name =]] starting with version v4.6.24 or higher, regardless of its edition. To use this feature you must first install the packages and configure them. ## Install packages @@ -19,15 +19,6 @@ composer require ibexa/collaboration composer require ibexa/share ``` -If you have an arrangements with [[= product_name_base =]] to use Real-time editing feature, you also need to install following package: - -``` bash -composer require ibexa/fieldtype-richtext-rte -``` - -This command instals also `ibexa/ckeditor-premium` package and adds the new real-time editing functionality to the Rich Text field type. -It also modifies the permission system to account for the new functionality. - ## Add tables to the database Add the tables to the database: @@ -59,7 +50,7 @@ Then, run the following command, where `` is the same name that y psql < ibexa_share.sql ``` -This command modifies the existing database schema by adding database configuration required for using Collaborative editing. +This command modifies the existing database schema by adding database configuration required for using Content sharing. ## Modify the bundles file @@ -72,8 +63,6 @@ return [ // A lot of bundles… Ibexa\Bundle\Collaboration\IbexaCollaborationBundle::class => ['all' => true], Ibexa\Bundle\Share\IbexaShareBundle::class => ['all' => true], - Ibexa\Bundle\FieldTypeRichTextRTE\IbexaFieldTypeRichTextRTEBundle::class => ['all' => true], - Ibexa\Bundle\CkeditorPremium\IbexaCkeditorPremiumBundle::class => ['all' => true], ]; ``` @@ -86,9 +75,9 @@ php bin/console ibexa:migrations:import vendor/ibexa/collaboration/src/bundle/Re php bin/console ibexa:migrations:migrate --file=2025_08_26_10_14_shareable_user.yaml ``` -## Configure Collaborative editing +## Configure Content sharing -Once the packages are installed, before you can start Collaborative editing feature, you must enable it by following these instructions. +Once the packages are installed, before you can start Content sharing feature, you must enable it by following these instructions. ### Security configuration @@ -121,7 +110,7 @@ security: ### Configuration -You can configure Collaborative editing per [Repository](repository_configuration.md). +You can configure Content sharing per [Repository](repository_configuration.md). Under `ibexa.repositories..collaboration` [configuration key](configuration.md#configuration-files), indicate the settings for collaboration: @@ -174,53 +163,4 @@ In the example configuration above, the **Share** button is displayed for any co 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]([[= user_doc =]]/content_management/collaborative_editing/work_with_collaborative_editing/). -To add the real-time editing capabilities, continue with the instruction below. - -## Configure real-time editing - -You must have an arrangement 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. +You can now restart you application and start [working with the Content sharing feature]([[= user_doc =]]/content_management/collaborative_editing/). diff --git a/docs/ibexa_products/editions.md b/docs/ibexa_products/editions.md index d77aea65ed6..3b451bed614 100644 --- a/docs/ibexa_products/editions.md +++ b/docs/ibexa_products/editions.md @@ -62,7 +62,7 @@ The features brought by LTS Updates become standard parts of the next LTS releas | Feature | [[= product_name_headless =]] | [[= product_name_exp =]] | [[= product_name_com =]] | |-----------------|-----------------|-----------------|-----------------| | [AI Actions](ai_actions_guide.md) | ✔ | ✔ | ✔ | -| [Collaborative editing](collaborative_editing_guide.md) | ✔ | ✔ | ✔ | +| [Content sharing](content_sharing_guide.md) | ✔ | ✔ | ✔ | | [Date and time attribute type](date_and_time.md) | ✔ | ✔ | ✔ | | [Discounts](discounts.md) | | | ✔ | | [Integrated help](integrated_help.md) | ✔ | ✔ | ✔ | diff --git a/docs/permissions/limitation_reference.md b/docs/permissions/limitation_reference.md index 16c94e7c497..201a9132761 100644 --- a/docs/permissions/limitation_reference.md +++ b/docs/permissions/limitation_reference.md @@ -71,17 +71,17 @@ The Change Owner (`ChangeOwner`) limitation specifies whether the user can chang |------|------|------| |`1`|"Forbid"|The user cannot change owner of a content item| -## Collaborative editing limitations [[% include 'snippets/lts-update_badge.md' %]] +## Content sharing 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. +The Content sharing limitations specify how the user can use the [Content sharing](content_sharing.md) LTS Update. -### Collaborative editing Owner limitation +### Content sharing Owner limitation The Owner (`share_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 +- drafts they have been invited to preview #### Possible values @@ -89,18 +89,17 @@ If not specified, user can share: |------|------|------| |"self"|"self"| User can only share drafts that they own | -### Collaborative editing Scope limitation +### Content sharing Scope limitation -The Scope (`share_scope`) limitation specifies whether the user can share the preview and editing view with other users. +The Scope (`share_scope`) limitation specifies whether the user can share the preview 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 +### Content sharing PublicLink limitation The Public Link (`share_public_link`) limitation specifies whether the user can manage the settings of the shareable preview link. diff --git a/docs/permissions/permission_use_cases.md b/docs/permissions/permission_use_cases.md index e3d8d3bc964..cddebb95c31 100644 --- a/docs/permissions/permission_use_cases.md +++ b/docs/permissions/permission_use_cases.md @@ -133,7 +133,7 @@ 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. +To let users share content drafts for preview outside of a workflow, use the [Content sharing policies](policies.md#content-sharing) that come with the [Content sharing LTS Update](content_sharing.md). ## Multi-file upload diff --git a/docs/permissions/policies.md b/docs/permissions/policies.md index 629776bd849..cc666d04083 100644 --- a/docs/permissions/policies.md +++ b/docs/permissions/policies.md @@ -228,12 +228,11 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | | `versionremove` | remove archived content versions | [Content type](limitation_reference.md#content-type-limitation)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
Status
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation)
[Object State](limitation_reference.md#object-state-limitation) | | | `view_embed` | 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)
[Section](limitation_reference.md#section-limitation)
[Owner](limitation_reference.md#owner-limitation)
[Location](limitation_reference.md#location-limitation)
[Subtree](limitation_reference.md#subtree-limitation) | -#### Content collaborative editing [[% include 'snippets/lts-update_badge.md' %]] +#### Content sharing [[% include 'snippets/lts-update_badge.md' %]] | Module | Function | Effect | Possible limitations | |----------------------|-----------------------|--------------------------------------------------------------------------|----------------------| -| `content` | `share` | share content drafts with internal and external users through [collaborative editing](collaborative_editing.md) |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)
[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)
[Scope](limitation_reference.md#collaborative-editing-scope-limitation) | -| `rte` | `edit` | use [Real-time editing](collaborative_editing_guide.md#real-time-editing) | +| `content` | `share` | share content drafts with internal and external users through [Content sharing](content_sharing.md) |[Owner](limitation_reference.md#content-sharing-owner-limitation)
[PublicLink](limitation_reference.md#content-sharing-publiclink-limitation)
[Scope](limitation_reference.md#content-sharing-scope-limitation) | #### Content types @@ -294,11 +293,11 @@ The [discount](discounts.md) policies decide which actions can be executed by gi | | `edit` | edit a product | [Product Type](limitation_reference.md#product-type-limitation)
[Language](limitation_reference.md#language-limitation) | | | `view` | view products listed in the product catalog | [Product Type](limitation_reference.md#product-type-limitation) | -#### Product collaborative editing [[% include 'snippets/lts-update_badge.md' %]] +#### Product sharing [[% include 'snippets/lts-update_badge.md' %]] | Module | Function | Effect | Possible limitations | |----------------------|-----------------------|--------------------------------------------------------------------------|----------------------| -| `product` | `share` | share products with internal and external users through [collaborative editing](collaborative_editing.md) |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)
[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)
[Scope](limitation_reference.md#collaborative-editing-scope-limitation) | +| `product` | `share` | share products with internal and external users through [Content sharing](content_sharing.md) |[Owner](limitation_reference.md#content-sharing-owner-limitation)
[PublicLink](limitation_reference.md#content-sharing-publiclink-limitation)
[Scope](limitation_reference.md#content-sharing-scope-limitation) | #### Product types diff --git a/docs/product_guides/product_guides.md b/docs/product_guides/product_guides.md index 0882084c4d1..34af11b2161 100644 --- a/docs/product_guides/product_guides.md +++ b/docs/product_guides/product_guides.md @@ -16,7 +16,7 @@ Discover the primary ones with the help of product guides. Condensed content all "content_management/rich_text/online_editor_guide", "content_management/pages/page_builder_guide", "content_management/forms/form_builder_guide", - "content_management/collaborative_editing/collaborative_editing_guide", + "content_management/content_sharing/content_sharing_guide", "customer_management/customer_portal", "pim/pim_guide", "ibexa_cloud/ibexa_cloud_guide", diff --git a/docs/resources/new_in_doc.md b/docs/resources/new_in_doc.md index 37821c1c8f8..a9b11a76f66 100644 --- a/docs/resources/new_in_doc.md +++ b/docs/resources/new_in_doc.md @@ -326,9 +326,9 @@ This promotes skipping the rebuild of the Symfony container when environment var ### Collaborative editing - Improved Collaborative editing: - - Added [real-time editing configuration](install_collaborative_editing.md#configure-real-time-editing) - - Added Collaborative editing policies for [content items](policies.md#content-collaborative-editing) and [products](policies.md#product-collaborative-editing) - - Added [Collaborative editing limitations](limitation_reference.md#collaborative-editing-limitations) + - Added [real-time editing configuration](install_content_sharing.md) + - Added Collaborative editing policies for [content items](policies.md#content-sharing) and [products](policies.md#product-sharing) + - Added [Collaborative editing limitations](limitation_reference.md#content-sharing-limitations) ### Search @@ -405,8 +405,8 @@ We want to thank ### Collaborative editing - Described: - - [installation and configuration](install_collaborative_editing.md) in more detail - - [search criteria](collaboration_criteria.md) and [sort clauses](collaboration_sort_clauses.md) for [Collaborative editing](collaborative_editing.md) + - [installation and configuration](install_content_sharing.md) in more detail + - [search criteria](collaboration_criteria.md) and [sort clauses](collaboration_sort_clauses.md) for [Collaborative editing](content_sharing.md) - [events](collaboration_events.md) ### Extending Page Builder and Form builder @@ -460,7 +460,7 @@ We want to thank ### Collaborative editing -- Added the [Collaborative editing product guide](collaborative_editing_guide.md), describing the high-level overview of this feature +- Added the [Collaborative editing product guide](content_sharing_guide.md), describing the high-level overview of this feature - Described collaborative editing endpoints to the [REST API reference](https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#collaborative-editing) for [[= product_name =]] v4.6 ### Infrastructure diff --git a/docs/search/collaboration_search_reference/collaboration_criteria.md b/docs/search/collaboration_search_reference/collaboration_criteria.md index e07eb72408c..90b3b4c6df5 100644 --- a/docs/search/collaboration_search_reference/collaboration_criteria.md +++ b/docs/search/collaboration_search_reference/collaboration_criteria.md @@ -8,7 +8,7 @@ editions: # 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). +Use them to work with objects related to [Content sharing API](content_sharing_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 index 20b46d3f290..ff4c589caa7 100644 --- a/docs/search/collaboration_search_reference/collaboration_sort_clauses.md +++ b/docs/search/collaboration_search_reference/collaboration_sort_clauses.md @@ -8,7 +8,7 @@ editions: # 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). +Use them to work with objects related to [Content sharing API](content_sharing_api.md). ## Invitation Search Sort Clauses diff --git a/mkdocs.yml b/mkdocs.yml index 476d6e20a5d..3c80fbed11a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -293,12 +293,12 @@ nav: - Time field type: content_management/field_types/field_type_reference/timefield.md - URL field type: content_management/field_types/field_type_reference/urlfield.md - User field type: content_management/field_types/field_type_reference/userfield.md - - Collaborative editing: - - Collaborative editing: content_management/collaborative_editing/collaborative_editing.md - - Collaborative editing product guide: content_management/collaborative_editing/collaborative_editing_guide.md - - Install and configure Collaborative editing: content_management/collaborative_editing/install_collaborative_editing.md - - Collaborative editing API: content_management/collaborative_editing/collaborative_editing_api.md - - Extend Collaborative editing: content_management/collaborative_editing/extend_collaborative_editing.md + - Content sharing: + - Content sharing: content_management/content_sharing/content_sharing.md + - Content sharing product guide: content_management/content_sharing/content_sharing_guide.md + - Install and configure Content sharing: content_management/content_sharing/install_content_sharing.md + - Content sharing API: content_management/content_sharing/content_sharing_api.md + - Extend Content sharing: content_management/content_sharing/extend_content_sharing.md - Templating: - Templating: templating/templating.md - Render content: diff --git a/plugins.yml b/plugins.yml index 038d2e39d77..183c5a22a65 100644 --- a/plugins.yml +++ b/plugins.yml @@ -600,4 +600,9 @@ plugins: 'getting_started/install_on_ibexa_cloud.md': 'ibexa_cloud/install_on_ibexa_cloud.md' 'infrastructure_and_maintenance/clustering/ddev_and_ibexa_cloud.md': 'ibexa_cloud/ddev_and_ibexa_cloud.md' 'ai_actions/configure_ai_actions.md': 'ai_actions/install_ai_actions.md' - 'content_management/collaborative_editing/configure_collaborative_editing.md': 'content_management/collaborative_editing/install_collaborative_editing.md' + 'content_management/collaborative_editing/configure_collaborative_editing.md': 'content_management/content_sharing/install_content_sharing.md' + 'content_management/collaborative_editing/collaborative_editing.md': 'content_management/content_sharing/content_sharing.md' + 'content_management/collaborative_editing/collaborative_editing_guide.md': 'content_management/content_sharing/content_sharing_guide.md' + 'content_management/collaborative_editing/install_collaborative_editing.md': 'content_management/content_sharing/install_content_sharing.md' + 'content_management/collaborative_editing/collaborative_editing_api.md': 'content_management/content_sharing/content_sharing_api.md' + 'content_management/collaborative_editing/extend_collaborative_editing.md': 'content_management/content_sharing/extend_content_sharing.md'