Followup to #1697256: Create a UI for importing new configuration. The hook_help() text for the CMI synch operation could use some improvement and clarification, and the documentation page to which it links needs to be written.

Background: part of the task to update the hook_help texts of the modules for Drupal 8:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks:
- review / write the hook_help text according to help guidelines
- review if the text in aggregator_help() is up to date for Drupal 8
- test the links embedded in the text
- update/review d.o. docs at http://drupal.org/documentation/modules/config

Files: 
CommentFileSizeAuthor
#13 node-2182101.txt1.59 KBbatigolix
#4 drupal-config-synchronizing-help-text-1831798-4.patch1.05 KBpaul.linney
PASSED: [[SimpleTest]]: [MySQL] 63,161 pass(es).
[ View ]

Comments

xjm’s picture

Component:views.module» documentation
xjm’s picture

batigolix’s picture

paul.linney’s picture

Assigned:Unassigned» paul.linney
Issue summary:View changes
Status:Active» Needs review
StatusFileSize
new1.05 KB
PASSED: [[SimpleTest]]: [MySQL] 63,161 pass(es).
[ View ]
  • Fixed the path for synchronize config help text
  • Added help text for synchronize page
  • Added link to documentation for synchronizing config https://drupal.org/node/2182101

Let me know if any omissions/errors.

regards,
Paul

mtift’s picture

@paul.linney: Thanks for the patch. Is there a reason why we need http://drupal.org/node/2182101 in addition to http://drupal.org/documentation/administer/config? It seems like the help text could just link to http://drupal.org/documentation/administer/config.

batigolix’s picture

Status:Needs review» Needs work
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules

Let's also use this issue to review the whole hook_help text of the Config module.

We are reviewing all the hook_help texts for all D8 modules see #1908570: [meta] Update or create hook_help() texts for D8 core modules.

The current text does not refer to the online docs conform the standard help template, see http://drupal.org/node/632280. It should read For more information, see <a href="!translation">the online documentation for the Configuration Manager module</a>.

Another problem is that the about section mentions the the module "provides a user interface". But we do no explain anything about that UI.

There should be a Uses section (again conform the standard help template, see http://drupal.org/node/632280) to explain what the site admin can do with this module, with links to the UI page(s).

batigolix’s picture

Agree with #5 let see if that http://drupal.org/node/2182101 is necessary if we already have http://drupal.org/documentation/administer/config

It seems that Paul's version is more up-to-date. Is that the case?

paul.linney’s picture

My page only really covers the synchronization page, so yes it could be included on the original config page or they could be split up into subsections:

  • Configuration settings
  • Synchronization
  • Import Export
  • Example Scenarios

If there is agreement on this, then I'll reorganise and fix the help template as suggested and point to the main page (https://drupal.org/documentation/administer/config)

regards,
Paul

mtift’s picture

We are still trying to make configuration synchronization work: #2121751: [META] Making configuration synchronisation work so it is still rather premature to document how synchronization works. The target use case, as well as a link to the META issue, is described on https://drupal.org/documentation/administer/config.

Another key point that needs to be emphasized wherever configuration synchronization is discussed is that (as far as Drupal core is concerned) synchronization will only work between Drupal installations that are the same site. (For more on this, see #2133325: Create a site UUID on install and only allow config sync between sites with the same UUID.)

Conceptually, I'd argue that there is very little difference between "managing configuration" and "synchronizing configuration" and that we don't need two separate documentation pages. In other words, I think updates should be made to http://drupal.org/documentation/administer/config.

paul.linney’s picture

I've updated the https://drupal.org/documentation/administer/config page including the information on the additional post I made and removed the other post.

Doc with all information

regards,
Paul

batigolix’s picture

The other post is this page, right --> https://drupal.org/node/2182101

It has not been removed. You want me to delete it? Or I can move it to ARCHIVE

cheers,
boris

paul.linney’s picture

Hi Boris,

Can you delete please, can't see the option to do it myself.

thanks,
Paul

batigolix’s picture

StatusFileSize
new1.59 KB

Deleted!

I saved the text as attachment here for posterity

Cheers,

Boris

batigolix’s picture

Issue summary:View changes

I added the standard hook_help review task description to the issue summary

jhodgdon’s picture

Status:Needs work» Postponed

Given #9, it seems like maybe we should postpone this issue until the Config module UI is really working?

xjm’s picture

It's working now. :) However, there is a related issue: #2247291: Configuration synchronization UI needs a usability review Leaving postponed on that for the moment.

jhodgdon’s picture

We just had a change to hook_help, on this issue: #2183113: Update hook_help signature to use route_name instead of path.

Here is the change record: https://drupal.org/node/2250345

This patch will need a reroll for this change.

batigolix’s picture

Issue tags:+documentation, +sprint

tagging

jhodgdon’s picture

Instead of having one critical parent issue I have been asked to change the status of each child issue.

This one doesn't seem to major to me. But yes we should get it done. And it still needs to be postponed because hopefully the UI of this area will be revised.

jhodgdon’s picture

Component:documentation» config.module
Priority:Normal» Major

Actually, I think this issue is at least major. There is pretty much no help at all in config_help() currently, and the concept of synchronization *definitely* needs to be explained to the user, as well as something about config storage.