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

Tasks:
- review / write the hook_help text according to help guidelines

Files: 
CommentFileSizeAuthor
#17 Path.png27.69 KBJuterpillar
#15 path-module-hook-help-2091353-15.patch3.81 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 64,487 pass(es).
[ View ]
#15 interdiff.txt3.53 KBbatigolix
#6 path-module-hook-help-2091353-4.patch3.48 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,925 pass(es).
[ View ]
#2 path-module-hook-help-2091353-2.patch3.49 KBbabruix
FAILED: [[SimpleTest]]: [MySQL] Failed to run tests: failed to enable simpletest module.
[ View ]

Comments

Assigned:Unassigned» babruix
Issue tags:+prague 2013

Assigned:babruix» Unassigned
Status:Active» Needs review
Issue tags:-prague 2013
StatusFileSize
new3.49 KB
FAILED: [[SimpleTest]]: [MySQL] Failed to run tests: failed to enable simpletest module.
[ View ]

Initial patch changes tokens and uses \Drupal::url
Not sure about changes in module and path system, should some information be changed?

Status:Needs review» Needs work

The last submitted patch, path-module-hook-help-2091353-2.patch, failed testing.

Status:Needs work» Needs review

Status:Needs review» Needs work

Someone needs to go through the help that is here and see if what it says still matches the Drupal 8 user interface. If you would like to do that before you make a new patch, that would be helpful.

Other changes needed:

a) All drupal.org links should be changed to https.

b) Links are still not using the correct formatting using routes instead of paths. See
https://drupal.org/node/632280#url-note

Thanks! And sorry for not reviewing this sooner -- I'm still behind from the great Prague help sprint.

Component:documentation» path.module
Status:Needs work» Needs review
StatusFileSize
new3.48 KB
PASSED: [[SimpleTest]]: [MySQL] 59,925 pass(es).
[ View ]

Patch fixes a) & b) from #5

The text matches to current UI which seems not have undergone major changes for D8

Setting component to path.module to let maintainers chime in

I'm wondering if the array('fragment' => 'module-path') piece in the permissions link is actually supposed to work in combination with overlay. The resulting url is http://d8.local/#overlay=admin/people/permissions%23module-path
I'm trying this with overlay but the browser does not navigate to this anchor ...

Issue tags:+Needs manual testing

Yeah, fragments do not work with the overlay. However, they can be tested by turning off the overlay, and they're helpful for people who don't use the overlay.

Anyway, the patch in #6 looks fine. Can someone give it a manual test to see that:
a) All the links go to where they should be going
b) The names of pages/sections mentioned in the help text match the actual names of the pages in the administrative UI... I guess the only one mentioned is on content editing it says "URL path settings" -- can it be verified that this is still what it says?

Thanks!

Status:Needs review» Needs work

The last submitted patch, 6: path-module-hook-help-2091353-4.patch, failed testing.

Status:Needs work» Needs review

Issue summary:View changes
Issue tags:+Novice

Need test. See #6

Status:Needs review» Needs work

I gave this a manual test today and it all looks great except for one conceptual problem.

The "Creating" uses item says that you can create aliases when you create content. This is true for Nodes, but one of the examples it gives is for a user alias, and I am not seeing the ability to create an alias for a user page when I create the user page. With only the core User and Path modules, I think if you wanted to create an alias for user/3 you would need to do it from the alias list, not while you are creating the user.

And the field where you can add a URL alias on a Taxonomy term is not called the same thing. It just says "URL alias" instead of "URL path settings".

So I think this is a bit misleading. I'm not sure what the best way to fix it would be, and I'm not sure why the URL alias is not available for users and looks different for taxonomy terms either. Any comments from the Path maintainers?

Status:Needs work» Needs review
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules
StatusFileSize
new1.88 KB
new3.8 KB
PASSED: [[SimpleTest]]: [MySQL] 63,766 pass(es).
[ View ]

This patch attempts to fix the problem raised in #12. The style is not very refined but I think it is clear and not misleading anymore. Suggestions for improvement are always welcome.

I don't think the labeling is different. In the case of the Node it is the "vertical tab label" (form element 'type'= '#details' ?) that is named "URL path settings". The actual input field for both taxo term and node are labeled URL alias.

Status:Needs review» Needs work

Better -- I think that is much clearer.

I missed this in the last review, whoops: The link to the online docs needs updating to our standard wording (still says "handbook").

I'm also wondering, since all the field/section names on the taxonomy/node edit pages are in "Sentence case", if the text would be clearer if they were in quotes? Such as

... under the section URL path settings in the field URL alias ...

vs.

... under the section "URL path settings" in the field "URL alias"...

?

Status:Needs work» Needs review
StatusFileSize
new3.53 KB
new3.81 KB
PASSED: [[SimpleTest]]: [MySQL] 64,487 pass(es).
[ View ]

Ok. fixed remarks from #14

Looks good to me, thanks!

Needs a manual test:
- Verify that all the links work
- Verify that all mentions of pages/text within the UI match what is seen in the UI
- Verify that the formatting is OK.

Status:Needs review» Reviewed & tested by the community
StatusFileSize
new27.69 KB

Have tested this on simplytest.me and verified that it passes html validation and spelling/punctuation is error free.

Here's the screenshot with the patch applied.

Component:path.module» documentation

Thanks for testing! Moving back to Docs component so I see it next time I'm doing commits.

Status:Reviewed & tested by the community» Needs review

A major change to the Path module was just committed:
#1980822: Support any entity with path.module
so I think we should review this help again and make sure it still matches the UI. I'll also click "retest" just in case.

The UI for this module may not have changed yet. See #2201051: Convert path.module form alters to a field widget

Status:Needs review» Postponed

Let's postpone this until #2201051: Convert path.module form alters to a field widget is finished.