Problem/Motivation

Currently the editorial workflow includes the word "workflow" in its label.
This causes problems when building informational messages for the UI, where you would want to print %workflow workflow - if you do so you would get Editorial workflow workflow.

This a known issue which has surfaced during #2830584: Use modals for creating, updating, and deleting workflows, with a new DialogFormTrait (see comment #66 point 9).

Proposed resolution

Change the Editorial workflow label to "Editorial"

Remaining tasks

Do it.

User interface changes

None

API changes

None

Data model changes

None

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Manuel Garcia created an issue. See original summary.

Manuel Garcia’s picture

Status: Active » Needs review
FileSize
2.15 KB
Manuel Garcia’s picture

Issue summary: View changes
amateescu’s picture

Status: Needs review » Reviewed & tested by the community

Makes perfect sense :)

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 2: 2894499-2.patch, failed testing. View results

timmillwood’s picture

Status: Needs work » Reviewed & tested by the community

Unrelated fail.

Manuel Garcia’s picture

Issue summary: View changes
larowlan’s picture

Status: Reviewed & tested by the community » Needs review

Do we want an update hook/post update hook to change the label on existing installs?

timmillwood’s picture

As it doesn't really make a difference to the usage and its an experimental module, I'd vote no.

Sam152’s picture

Status: Needs review » Reviewed & tested by the community

Given experimental status, I think no upgrade path is best. Adding a single test for an upgrade path ensures that any future non-upgrade-path entity schema changes will actually fail that test, even if unrelated to the thing originally being tested, which we don't want.

While the schema/BC is being rapidly broken, I think even adding an upgrade path for changes which are really easy sends the wrong message. If a user sees an updb, I think that contributes to the very wrong expectation that there is some kind of upgrade path in place.

xjm’s picture

Status: Reviewed & tested by the community » Needs work
FileSize
59.28 KB
103.03 KB
50.47 KB

Hey, I have a screenshot of the "Editorial workflow workflow" bug on my desktop too. :) Glad someone else filed and fixed it since I didn't get around to it.

Do we want an update hook/post update hook to change the label on existing installs?

In general, we should not update existing sites based on changes we decide to make for default configuration, because we have no way of knowing if they got the value from defaults shipped by core and don't care about it, or if they got it another way or chose it on purpose. If we change sites' stored configuration in this way, we might be breaking something they changed on purpose. This is the idea that "sites own their configuration, not modules". (Further reading: https://www.chapterthree.com/blog/principles-of-configuration-management...)

So I agree that we don't need an update hook here.

I confirmed this is replacing all instances by scanning the results of a grep for "editorial".

I also double-checked what it looks like now on other admin screens:

This change made me notice that we should probably have the title for the edit page be "Edit %workflow workflow" also.
Compare content types:

I'm sort of on the fence as to whether or not this should be in scope. Fixing the "Editorial workflow workflow" bug is introducing a different usability issue for content moderation, because in contexts where the workflow label is used without the word workflow, it's now less clear for the editorial workflow, at least. So that's a case for adding it to the scope for this issue. If others disagree on that scope expansion, though, I'd at least like a followup issue for that.

Meanwhile, my second screenshot shows a different usability issue, which is that the description of the label field does not add any meaningful information, so it should be removed. That's definitely out of scope so I made this: #2897686: Description for workflow label field does not add any information

amateescu’s picture

Status: Needs work » Needs review
FileSize
2.78 KB
637 bytes

Thanks @xjm for the review, excellent point on making the title of the workflow edit form more descriptive. Let's do that :)

timmillwood’s picture

Status: Needs review » Reviewed & tested by the community

Think we're good to go back to RTBC!

larowlan’s picture

Status: Reviewed & tested by the community » Fixed

Committed as 6fb8ad4 and pushed to 8.4.x.

  • larowlan committed 6fb8ad4 on 8.4.x
    Issue #2894499 by amateescu, Manuel Garcia, xjm: Rename 'Editorial...

  • larowlan committed e7d4350 on 8.4.x
    Revert "Issue #2894499 by amateescu, Manuel Garcia, xjm: Rename '...
larowlan’s picture

Status: Fixed » Needs work

This caused a fail in HEAD, reverted

amateescu’s picture

Status: Needs work » Reviewed & tested by the community
FileSize
3.64 KB
877 bytes

Then let's fix it :)

larowlan’s picture

+++ b/core/modules/content_moderation/tests/src/Kernel/ContentModerationWorkflowConfigTest.php
@@ -123,7 +123,7 @@ public function testDeletingStateViaConfiguration() {
-        'The workflow Editorial workflow is being used, and cannot be deleted.',
+        'The workflow Editorial is being used, and cannot be deleted.',

thus highlighting the need for this patch!

will recommit after full run

The last submitted patch, 12: 2894499-12.patch, failed testing. View results

  • larowlan committed b3aa553 on 8.4.x
    Issue #2894499 by amateescu, Manuel Garcia, xjm: Rename 'Editorial...
larowlan’s picture

Status: Reviewed & tested by the community » Fixed

OK, take 2 committed as b3aa553 and pushed to 8.4.x.

Thanks for the quick turnaround on the patch.

See you in the other workflow/content moderation issues

Status: Fixed » Closed (fixed)

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