Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 'Require Revision Log Message' module to GovCMS #752

Open
StephenOllman opened this issue May 15, 2023 · 4 comments
Open

Add 'Require Revision Log Message' module to GovCMS #752

StephenOllman opened this issue May 15, 2023 · 4 comments

Comments

@StephenOllman
Copy link

Would llike to see if there is appetite for this functionality.

** What value does this module/package add to GovCMS?
Enables site administrators to require a revision comment by content authors when editng site content. Node bundles this applies to can be configured at /admin/config/requireRevisionLog/adminsettings

** Is the module Drupal 10 compatible?
Yes: Works with Drupal: ^8.8 || ^9 || ^10

** Please provide a brief outline of what this module does.
When the module is installed, it requires revision log information on all node changes, regardless of whether the "Create new revision" option was chosen on the content type.

** Who does this module benefit:
[ ] end users
[X] content editors
[ ] site builders
[ ] themers
[ ] developers

** How could you provide/replicate the functionality of this module using alternative methods, eg in your theme?
It might be possile to theme the 'Revision log message' field so that it is mandatory.

** If this module styles or alters HTML or JavaScript output, can the functionality be provided via the theme? What alternatives have you considered.
N/A

** What is the maintenance and support status of the module. Describe the issue queue activity.
3 open issues, 12 resolved issues. Low issues.

** What permissions are needed to utilise the module (and are any new permissions provided by the module)?
Seems that once enabled all content type node revisions would require a revision comment.

** Does the module modify the database structure and/or store additional metadata on nodes or other entities? If so, why? What are the risks for future updates?
It looks like the module does have an admin configuration component and as such a database touch point: Node bundles this applies to can be configured at /admin/config/requireRevisionLog/adminsettings

** Is the module designed to capture anonymous user data?
No

** Is the output of the module typically fully cacheable? Would the inclusion of this module potentially render pages uncacheable.
N/A - affects content authoring only.

** What is your assessment of the quality of this module, the contribution history of the module's maintainers, and the uptake of the module within the Drupal community?
Seems actively maintained with responsive updates by the maintainers.

** Additional information
If this same functionality can be achieved via the theme layer I'm happy to go down that path, but wonder if this kind of functionality would be benefitial to a number of site administrators that can be accomplished via ths module, instead of adding custom theme code.

@StephenOllman StephenOllman added the enhancement New feature or request label May 15, 2023
@thisisalistairsaccount
Copy link

HI @StephenOllman interesting there isn't an option OOTB for something like this in Core.

Noting your comment with theme layer, it certainly feels possible, noting you could manage it with some scripting, but possibly not ideal. Alternatively, there's also the option for another required field as part of a content type with the control there, presumably then not showing that on the output.

I'll flag this with "requires more feedback/community interest" just to see if anyone else is looking for the same.

@thisisalistairsaccount
Copy link

thisisalistairsaccount commented May 30, 2023

There's also some commentary on the message field being required issue and then jumps in a couple of different directions at https://www.drupal.org/project/drupal/issues/308352

@brett-sargeant
Copy link

Personally I don't ever use the revision log, one of my team members does as they were used to it from a previous version, but no one else. However my team does most of the publishing for the department and who/when/why is managed through a different process.

@StephenOllman
Copy link
Author

From a simple record keeping point of view we find it helps to easily identify what changed in a node, along with who made the change. We've also tweaked our /admin/content page to show the latest revision notes against a node.
This might just be an agency specific requirement, in which case a themed based solution might be best.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants