Problem/Motivation

The UI texts on five administration pages for the Configuration manager are not very consistent, and therefore a bit confusing.
Since the using YAML files for configuration management is a new concept in Drupal 8, compared to Drupal 7, a lot of site builders will need to learn how this works, so we should get these texts as clear as possible.

Proposed resolution

Update the UI texts on the five administration pages, using the wording of the hook_help text as a reference.

Remaining tasks

Update the UI texts.

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

Title: Update the UI texts on the Configuration manager administration pages » Update the UI texts for the Configuration Manager module
ifrik’s picture

Issue tags: +Usability
pguillard’s picture

A first proposal, based on hook_help texts.

phantomvish’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
FileSize
92.12 KB

The patch works ! updates the UI text as intended.

2572537

pguillard’s picture

@phantomvish : Thanks for your review !
But I guess we need more reviews for RTBC.

ifrik’s picture

Status: Reviewed & tested by the community » Needs review

Hi and thanks for the patch and review.

I'll ask for a usability review as well.

yoroy’s picture

Status: Needs review » Needs work
  1. +++ b/core/modules/config/config.module
    @@ -33,27 +33,27 @@ function config_help($route_name, RouteMatchInterface $route_match) {
    +      $output .= '<p>' . t('You can review differences between the active configuration and an imported configuration archive on this page to ensure that the changes are as expected, before finalizing the import. This page also shows configuration items that would be added or removed.') . '</p>';
    

    What is the value of the last sentence here? Maybe:

    "Review differences between the active configuration and an imported configuration archive to ensure that the changes are as expected, before finalizing the import."

  2. +++ b/core/modules/config/config.module
    @@ -33,27 +33,27 @@ function config_help($route_name, RouteMatchInterface $route_match) {
    +      $output .= '<p>' . t('You can create and download an archive consisting of all your site\'s configuration exported as *.yml files.') . '</p>';
    

    Start directly with "Create and download…"

  3. +++ b/core/modules/config/config.module
    @@ -33,27 +33,27 @@ function config_help($route_name, RouteMatchInterface $route_match) {
    +      $output .= '<p>' . t('You can upload a full site configuration from an archive file. When importing data from a different environment, the site and import files must have matching configuration values for UUID in the system.site configuration item. That means that your other environments should initially be set up as clones of the target site. Migrations are not supported.') . '</p>';
    

    Don't think we should explain what you can not do here. Is there a handbook to link to maybe? Or only say: "You can only import if the UUID in the system.site configuration item is the same."

  4. +++ b/core/modules/config/config.module
    @@ -33,27 +33,27 @@ function config_help($route_name, RouteMatchInterface $route_match) {
         case 'config.import_single':
    ...
    +      $output .= '<p>' . t('You can import a single configuration item by pasting it in YAML format.') . '</p>';
    

    Remove the "You can". Try to start with a verb to get to the point asap :)

pguillard’s picture

Thanks @yoroy, I agree and applied your comments.

manauwarsheikh’s picture

I can see "You can" word as a prefix on few tabs on the page.Needs work(attached Screenshot).

manauwarsheikh’s picture

Status: Needs review » Needs work
Eli-T’s picture

Linking #2247291: Reorder tabs in configuration UI as if that rearranges and renames some of the tabs - this may have a knock on impact on this issue.

pguillard’s picture

Status: Needs work » Needs review
FileSize
2.45 KB

Thanks @manauwarsheikh, #10 applied

yoroy’s picture

Status: Needs review » Needs work

Thanks for the quick updates, I'm afraid I have some more changes to propose :-) Together with Eli-T we put #2247291: Reorder tabs in configuration UI back on track to get it rtbc and while reviewing we also had another good look at all the help texts. Here's the latest proposal with one additional change:

Synchronize page:
Compare the configuration uploaded to your staging directory with the active configuration before completing the import.

Full import:
Upload a full site configuration archive to the staging directory. It can then be compared and imported on the Synchronize page.

Single import:
Import a single configuration item by pasting its YAML structure into the text field.

Full export:
Export and download the full configuration of this site as a gzipped tar file.

Single export:
Choose a configuration item to display its YAML structure.

And:
Rename the "old/new" table headers to "active/staged" in the view differences modal.

pguillard’s picture

Status: Needs work » Needs review
FileSize
3.02 KB

#14 applied.

active/staged

is much better indeed

Eli-T’s picture

Thanks @pguillard, I'll take a look.

Eli-T’s picture

Status: Needs review » Needs work
+++ b/core/modules/config/src/Controller/ConfigController.php
@@ -143,8 +143,8 @@ public function diff($source_name, $target_name = NULL, $collection = NULL) {
+        array('data' => t('staged'), 'colspan' => '2'),

Any reason the case has changed here? Whilst this will be displayed uppercase either way due to text-transform: uppercase; in the theme, if someone is using a different theme, these headings will be displayed completely lowercase.

The rest of the patch looks good and makes the changes as suggested in #14.

However, we also need to remove the

Use the export button below to download your site configuration.

text on the Export Full archive tab as it's completely redundant.

a.milkovsky’s picture

Assigned: Unassigned » a.milkovsky

I can help here

a.milkovsky’s picture

Assigned: a.milkovsky » Unassigned
Status: Needs work » Needs review
FileSize
3.67 KB

text on the Export Full archive tab as it's completely redundant.

done

Any reason the case has changed here?

done

Eli-T’s picture

Thanks @a.milkovsky!

Can you add an interdiff please? https://www.drupal.org/documentation/git/interdiff

ifrik’s picture

Thanks for all the work, and for tying this in with the re-ordering of the tabs.

The help text refers to the correct page titles, and the explanation texts are on the administration pages are clear.

Eli-T’s picture

FileSize
1.39 KB

Adding interdiff

Eli-T’s picture

Status: Needs review » Reviewed & tested by the community

Patch in #19 implements all of the suggestions made by @yoroy, looks good to me.

yoroy’s picture

Thanks all. Yes, this is good to go.

Eli-T’s picture

Schnitzel’s picture

Postponed #2487588: Move CMI import/export directory "staging" to "sync", as it is confused with staging environments so this one can get in first.

Reviewed the changes as well, and I like!

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed f8e3bf2 and pushed to 8.0.x. Thanks!

  • alexpott committed f8e3bf2 on 8.0.x
    Issue #2572537 by pguillard, a.milkovsky, manauwarsheikh, Eli-T,...

Status: Fixed » Needs work

The last submitted patch, 19: update_ui_texts_for_configuration_manager-2572537-20.patch, failed testing.

jhodgdon’s picture

Status: Needs work » Fixed

Nice!

Status: Fixed » Closed (fixed)

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