Problem/Motivation

The module description should only be one sentence that easy to understand for new users. It should also be so short that users don't need to scroll sideways.
See https://www.drupal.org/docs/develop/documenting-your-project/help-text-s...

Proposed resolution

Reword the description to something like "provides an interface to create workflows with transitions between different publication states."

Remaining tasks

None

User interface changes

This is a UI text change.

API changes

None.

Data model changes

None.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

ifrik’s picture

ifrik’s picture

Title: Update the module description » Update the Workflows module description
wengerk’s picture

Status: Needs review » Reviewed & tested by the community

Thanks for your proposal. Seems fine to me.

alexpott’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/modules/workflows/workflows.info.yml
@@ -1,6 +1,7 @@
+description: 'Provides an interface to create workflows with transitions between different publication states
+provided by other modules.'

Whilst YAML supports a multiline formats I think this would be the first in core. I think if we want to make this change we should be consistent and introduce a standard and enforce it via PHPCS. For example, seven.info.yml has a very long description too.

+1 to rewording the description though. Also if we do make this multi-line we need to check that the potx extractor still manages to read these lines.

ifrik’s picture

Status: Needs work » Needs review
Issue tags: +user interface text
FileSize
631 bytes

It hadn't even been my intention to introduce this a new pattern :-)
It's all in one line now.

John Cook’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
40.88 KB
35.03 KB

I've checked the patch in comment 6.

Before:

After:

The description is now one sentence and is shorter than previously.

Setting to RTBC.

Gábor Hojtsy’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/modules/workflows/workflows.info.yml
@@ -1,6 +1,6 @@
-description: 'Provides UI and API for managing workflows. This module can be used with the Content moderation module to add highly customizable workflows to content.'
+description: 'Provides an interface to create workflows with transitions between different publication states provided by other modules.'

The module is not really limited for publication states. It can set up a workflow for user status (Newbie, Intermediate, Pro) or any other states and transitions. Publication states is just one possible use which is why the two modules are separate.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

ifrik’s picture

Working on it during DevDaysTransylvania together with #2861849: Edit hook_help text for Workflows module

ifrik’s picture

Status: Needs work » Needs review
FileSize
660 bytes

Changed the wording so that it's clear that this can apply to different types of states.

pguillard’s picture

It seems good to me, not too long, and not too specific.

pguillard’s picture

Status: Needs review » Reviewed & tested by the community

Let's go for RTBC !

catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed ca0daca and pushed to 8.8.x. Thanks!

  • catch committed ca0daca on 8.8.x
    Issue #2999423 by ifrik, John Cook, alexpott, Gábor Hojtsy: Update the...

Status: Fixed » Closed (fixed)

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