Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
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.
Comments
Comment #2
ifrikComment #3
ifrikComment #4
pguillard CreditAttribution: pguillard commentedA first proposal, based on hook_help texts.
Comment #5
phantomvish CreditAttribution: phantomvish commentedThe patch works ! updates the UI text as intended.
Comment #6
pguillard CreditAttribution: pguillard commented@phantomvish : Thanks for your review !
But I guess we need more reviews for RTBC.
Comment #7
ifrikHi and thanks for the patch and review.
I'll ask for a usability review as well.
Comment #8
yoroy CreditAttribution: yoroy at Wunder commentedWhat 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."
Start directly with "Create and download…"
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."
Remove the "You can". Try to start with a verb to get to the point asap :)
Comment #9
pguillard CreditAttribution: pguillard commentedThanks @yoroy, I agree and applied your comments.
Comment #10
manauwarsheikh CreditAttribution: manauwarsheikh commentedI can see "You can" word as a prefix on few tabs on the page.Needs work(attached Screenshot).
Comment #11
manauwarsheikh CreditAttribution: manauwarsheikh commentedComment #12
Eli-TLinking #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.
Comment #13
pguillard CreditAttribution: pguillard commentedThanks @manauwarsheikh, #10 applied
Comment #14
yoroy CreditAttribution: yoroy at Wunder commentedThanks 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.
Comment #15
pguillard CreditAttribution: pguillard commented#14 applied.
is much better indeed
Comment #16
Eli-TThanks @pguillard, I'll take a look.
Comment #17
Eli-TAny 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
text on the Export Full archive tab as it's completely redundant.
Comment #18
a.milkovskyI can help here
Comment #19
a.milkovskydone
done
Comment #20
Eli-TThanks @a.milkovsky!
Can you add an interdiff please? https://www.drupal.org/documentation/git/interdiff
Comment #21
ifrikThanks 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.
Comment #22
Eli-TAdding interdiff
Comment #23
Eli-TPatch in #19 implements all of the suggestions made by @yoroy, looks good to me.
Comment #24
yoroy CreditAttribution: yoroy at Wunder commentedThanks all. Yes, this is good to go.
Comment #25
Eli-TJust come across #2487588: Move CMI import/export directory "staging" to "sync", as it is confused with staging environments which proposes different changes to some of these same strings.
Comment #26
Schnitzel CreditAttribution: Schnitzel at Amazee Labs commentedPostponed #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!
Comment #27
alexpottCommitted f8e3bf2 and pushed to 8.0.x. Thanks!
Comment #30
jhodgdonNice!