Merge pull request #17 from donquixote/group-documentation

WIP - Group documentation

README.md

@@ -101,7 +101,7 @@ Minimal steps to see the editor in action:
 
 Advanced usage:
 - Configure roles and permissions as in "User permissions" section below.
-- Create a non-admin user with sufficient roles, login, 
+- Create a non-admin user with sufficient roles, login,
 
 ### Running the tests
 
@@ -198,19 +198,19 @@ not needed, if the Collabora instance is configured from outside of
 Drupal.
 
 For each media type, the module introduces four permissions:
-- "(media type): Edit any media file in Collabora"  
+- "(media type): Edit any media file in Collabora"
   Users with this permission are allowed to edit documents attached
   to a media entity of the given type, using the Collabora Online
   editor.
-- "(media type): Edit own media file in Collabora"  
+- "(media type): Edit own media file in Collabora"
   Users with this permission are allowed to edit documents attached
   to a media entity of the given type, using the Collabora Online
   editor, if they are the owner/author of that media entity.
-- "(media type): Preview published media file in Collabora"  
+- "(media type): Preview published media file in Collabora"
   Users with this permission are allowed to preview documents attached
   to a published media entity of the given type, using the Collabora
   Online editor in preview/readonly mode.
-- "(media type): Preview own unpublished media file in Collabora"  
+- "(media type): Preview own unpublished media file in Collabora"
   Users with this permission are allowed to preview documents attached
   to an unpublished media entity of the given type, using the Collabora Online
   editor in preview/readonly mode.
@@ -223,6 +223,14 @@ Developers can use entity access hooks to alter which users may edit
 or preview media files in Collabora. This would allow to grant access
 based on e.g. membership in a group.
 
+### Views
+
+The module integrates with Views by providing links as view fields, allowing
+users to perform specific operations on documents directly from the view display.
+
+These operations include actions such as "preview" and "edit," which can be
+easily accessed through the generated links.
+
 ### Other configuration
 
 If you need to change the accepted extensions to upload, go to
@@ -246,6 +254,13 @@ upload_max_filesize = 30M
 
 These set the limits to a maximum of 30M. You can change as appropriate.
 
+Sub-modules
+-------------
+
+### Collabora Online Group
+
+Integration of Collabora Online with Group module. Check out the [README](/modules/collabora_online_group/README.md) of the module.
+
 License
 -------
 

modules/collabora_online_group/README.md

@@ -0,0 +1,35 @@
+Collabora Online Group
+=====================================
+
+This submodule integrates the Group module (https://www.drupal.org/project/group)
+by managing group-related permissions. It allows fine-grained control over user
+access within groups, enabling specific permissions for Collabora content and
+actions based on group membership.
+
+### Requirements
+
+- Groupmedia module: https://www.drupal.org/project/groupmedia
+  - Compatible with versions 3.x and 4.x.
+
+### User permissions
+
+The module maps existing Collabora media operation permissions to the group type
+instances.
+
+#### Permissions:
+- "(media type): Edit any media file in Collabora"
+- "(media type): Edit own media file in Collabora"
+- "(media type): Preview published media file in Collabora"
+- "(media type): Preview own unpublished media file in Collabora"
+
+Check [Collabora Online README](/README.md#user-permissions) for more information about permissions.
+
+### Views
+
+Additionally, the submodule modifies Groupmedia view configuration to add links
+for Collabora operations.
+
+License
+-------
+
+This module is published under the MPL-2.0 license.