While evaluating this module, I noticed that it had a README but it lacked any useful information.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Patch to follow, thanks!

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Active » Needs work
FileSize
3.33 KB

I uploaded a patch that adds useful information, links, and configs to the existing README. Thanks!

alonaoneill’s picture

Status: Needs work » Reviewed & tested by the community

Patch applied using simplytest.me. Reviewed the patch for spelling, grammar, syntax and link paths. Formatting aligns to Drupal documentation standards.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Marking RTBC. Thanks for your work on a module.

MegaChriz’s picture

Status: Reviewed & tested by the community » Fixed
FileSize
2.75 KB

Thanks for the patch! I made a few changes in the text and committed that.

Review:

  1. +++ b/README.txt
    @@ -1,6 +1,95 @@
    + * Delete operation (user/X/delete or user/X/cancel)
    

    It is user/X/cancel only in D8.

  2. +++ b/README.txt
    @@ -1,6 +1,95 @@
    +User based protection rules:
    +This user will be protected for all users except: "User 1" (admin), the
    +protected user itself, and users with the permissions to "Bypass all user
    +protections".
    ...
    + * User based protection rules:
    +   This user will be protected for all users except: "User 1" (admin), the
    +   protected user itself, and users with the permissions to "Bypass all user
    +   protections".
    

    This is provided twice in the text.

  3. +++ b/README.txt
    @@ -1,6 +1,95 @@
    +   In Drupal 8, this can be configured with a user permission. In Drupal 7, by
    +   adding a bypass rule at /admin/config/people/userprotect/administrator_bypass
    +   (for one specific user) or by changing the "Administrator bypass defaults" at
    +   /admin/config/people/userprotect/protection_defaults (for all users, except
    +   the ones for which a bypass rule exists).
    

    I left this out. For the D8 module there is no need to specify how things worked in the D7 version.

  4. +++ b/README.txt
    @@ -1,6 +1,95 @@
    +and delete operations are protected by controlling access on the paths
    +user/X/edit and user/X/delete.
    

    Controlling access on paths is done in the D7 version only. In D8 it is done by using entity access.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.