Problem/Motivation

When a log is "rescheduled" via the bulk action provided by this module, it would be nice if a revision message could be recorded alongside it. This would provide some visibility into WHY a log is rescheduled, for future reference.

Proposed resolution

Add a "Revision message" field to the bulk action forms. I think all of them could benefit from this.

We may even want to prepend something like "Rescheduled: [message]" to give it even more specificity.

Remaining tasks

TBD

User interface changes

New "Revision message" field in bulk actions.

API changes

None.

Data model changes

None.

Issue fork log-3258268

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

m.stenta created an issue. See original summary.

paul121 made their first commit to this issue’s fork.

paul121 opened merge request !7

paul121’s picture

paul121 CreditAttribution: paul121 commented

Add a "Revision message" field to the bulk action forms. I think all of them could benefit from this.

Adding this to the "Mark as done" and "Mark as pending" actions would introduce a new config form + step. I think this *could* be quite useful, but not all the time... perhaps we could make this step configurable via the action config entity?

We may even want to prepend something like "Rescheduled: [message]" to give it even more specificity.

I added "Rescheduled:" and "Cloned:" as placeholder text. I like this idea but am hesitant to *always* prepend something to the message. I did not make this the default value because then it makes it harder to support an "optional" revision message since the value would already be filled in. And want to avoid including a "Include revision" toggle - just use the empty textarea to detect if no revision message is to be included.

It would be interesting if we could make the default text configurable through the action config entity as well.

paul121’s picture

paul121 CreditAttribution: paul121 commented
Status: Active » Needs review
m.stenta’s picture

m.stenta
he/him
Primary language English
CreditAttribution: m.stenta commented
Status: Needs review » Reviewed & tested by the community

This is great! Thanks @paul121!

I added "Rescheduled:" and "Cloned:" as placeholder text. I like this idea but am hesitant to *always* prepend something to the message. I did not make this the default value because then it makes it harder to support an "optional" revision message since the value would already be filled in. And want to avoid including a "Include revision" toggle - just use the empty textarea to detect if no revision message is to be included.

All makes sense! I'm a little on the fence about the placeholder itself too. It works nicely as a "suggestion", and indication of what you could use it for - but I'm not sure if it adds value, because if you want to use the suggestion you still need to type it yourself. What do you think about removing the placeholders and just leaving a blank field?

Also, what do you think about changing the help text from "Briefly describe the changes you have made." to "Optionally add a message to describe this change. This will appear in the log's revisions." - Not much different, but emphasizes that it's optional, keeps the tense a bit more ambiguous, and notes where it will be saved.

I can make these two changes and merge this if you're OK with them!

m.stenta’s picture

m.stenta
he/him
Primary language English
CreditAttribution: m.stenta commented

I'm a little on the fence about the placeholder itself too. It works nicely as a "suggestion", and indication of what you could use it for - but I'm not sure if it adds value, because...

Just thought: it also just adds more strings that need translation... I've been getting more cognizant of this consideration since working on #3159886: [META] farmOS 2.x Localization

paul121’s picture

paul121 CreditAttribution: paul121 commented

All sounds good!

Also, what do you think about changing the help text from "Briefly describe the changes you have made." to "Optionally add a message to describe this change. This will appear in the log's revisions."

I actually used this to minimize on translated strings - this is what Drupal core uses for the revision message description!

But I like what you proposed, I think we could capture both the placeholder and the "optional" nature of this in an updated description. +1

m.stenta’s picture

m.stenta
he/him
Primary language English
CreditAttribution: m.stenta commented

I actually used this to minimize on translated strings - this is what Drupal core uses for the revision message description!

Oh good call! Didn't check that!

But I like what you proposed, I think we could capture both the placeholder and the "optional" nature of this in an updated description. +1

Haha OK - I'll commit. Six of one half dozen of the other! :-P

Thanks again!

  • m.stenta committed e0751d6 on 2.x authored by paul121 
    Issue #3258268 by paul121: Add revision message field to actions
m.stenta’s picture

m.stenta
he/him
Primary language English
CreditAttribution: m.stenta commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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