Add more documentation for Permissions By Entity?

Created on 16 January 2024, 10 months ago

Problem/Motivation

The current documentation for implementing the Permissions By Entity sub-module is currently fairly confusing / lacking detail.

The main module landing page states: "If you have installed the Permissions by Entity sub-module, any other content entity type, such as media entities, can be controlled in access restriction, too." which seems to imply that Permissions By Entity works out-of-the-box once installed.
However permissions By Entity is only referenced once in the Documentation page, and only in the #Examples section, stating: "and implement hook_file_download() by adapting the following code into your custom modules *.module file" which implies that the module doesn't work out-of-the box and requires custom code in order to work. These instructions are lacking a bit of context and specific instructions beyond the short code example.

Proposed resolution

Is it possible to add more exact instructions about:

  1. Where to implement the mentioned "custom module"
  2. How the custom module needs to be structured, i.e. necessary files, naming conventions, etc
  3. An example media type with taxonomy terms implemented, i.e. example fields, field settings, etc

Additionally, should this documentation be integrated into the main Documentation page, rather than mentioned briefly in the examples?

Thanks for your help on this, my team has been struggling to successfully implement Permissions By Entity on our site for a few weeks now and we are eager to use its functionality.

πŸ’¬ Support request
Status

Active

Version

3.1

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States cdupree

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024