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:
a) review / write the hook_help text according to help guidelines

b) (novice) Final manual testing:
1. Apply the patch.
2. Enable the Tracker module from admin/modules
3. Go to admin/help.
4. Click on the help page for this module (Tracker).
5. Verify that the help page is OK:
- Verify that all the links work
- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI
- Verify that the formatting is OK.

Comments

markconroy’s picture

Assigned:Unassigned» markconroy

I'll edit this.

markconroy’s picture

Status:Active» Needs review
StatusFileSize
new3 KB
PASSED: [[SimpleTest]]: [MySQL] 58,620 pass(es).
[ View ]

Some urls edited in the help text.

markconroy’s picture

StatusFileSize
new2.38 KB
new3 KB
PASSED: [[SimpleTest]]: [MySQL] 58,649 pass(es).
[ View ]

Just noticed a url issue, re-submitting.

petrpo’s picture

Assigned:markconroy» Unassigned
Status:Needs review» Active

I could not update it according to D8 docs standards because function tracker_help (file: tracker.module) has inside :

... array('!recent' => url('tracker'))...

and module tracker has no file tracker.routing.yml. Therefore I could not convert old url to new one.

petrpo’s picture

My previous comment is deprecated. I had no page refreshed. I am sorry.

petrpo’s picture

I checked it. It works right.

jhodgdon’s picture

Status:Active» Postponed

The Uses section is not following our standards for hook_help() - the headings should be -ing actions. So instead of "Tracking navigation", maybe the heading should be "Viewing the recent content list" or something like that? ... Actually, the topic really seems to be about the menu item and not about what is on the page, so probably this heading needs to reflect that. Probably it shouldn't be first in the list either -- it doesn't seem like the most important task to document?

Also, we need to convert url('admin/structure/menu')) to use the new routes format for URLs. This is not in the Tracker module -- it's from the Menu Links module I think? I am not sure why tracker is still using hook_menu() instead of a routing.yml file... that's very odd. Oh, it's in progress:
#1972990: Convert tracker_page() to a Controller
So probably we should postpone finishing this issue until that other one is completed.

jhodgdon’s picture

Issue summary:View changes
Status:Postponed» Active

Looks like the issue that was postponing this has been resolved.

batigolix’s picture

Component:documentation» tracker.module
Status:Active» Needs review
StatusFileSize
new2.76 KB
PASSED: [[SimpleTest]]: [MySQL] 63,187 pass(es).
[ View ]
new2.69 KB

This patch fixes the urls

I didnt find that whole Navigation point very informative, so I removed it

The help text mentions a user specific tracking page ("To follow a specific user's new and updated content, select the <em>Track</em> tab from the user's profile page.") that would be accessible from the account page. But the account page has no Track tab. At least not in my local D8 install. There does exist a route in tracker.routing.yml

I assign it to the tracker.module component in hope to get some feedback

The last submitted patch, 9: update-hook-help-tracker-2091429-9.patch, failed testing.

jhodgdon’s picture

That test failure is a random test problem, see:
#2157927: Intermittent test fails in LocaleUpdateTest
and it would be good NOT to click Retest on it so we can keep the test run report around. If you want a retest, please instead upload a new patch file.

So I think the latest patch is fine, but we need input from the tracker.module maintainers about the tabs and the intent there.

dimaro’s picture

I have tested it on my local and has not given errors. So I repeat the tests.

dimaro’s picture

jhodgdon’s picture

I had asked for retest not to be submitted. Oh well. :)

jhodgdon’s picture

Assigned:Unassigned» David Strauss

David Strauss: As the maintainer for the Tracker module, we need your input -- see comment #9.

jhodgdon’s picture

Title:Create hook_help for Tracker module» Update hook_help for Tracker module
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules

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.

DAVID STRAUSS: If you are maintaining Tracker... We asked for your input on April 1st. Please respond. Thanks!

David Strauss’s picture

The changes look good, at least in the sense of using the new API and not introducing regressions. So, +1 on committing.

However, we could use this as an opportunity to clean up the help lines in general. The "To follow a specific user's new and updated content" line in the patch context should move back to single quotes, given that it doesn't contain any single-quoted content. I'm also curious why "<a href='!recent'>" uses single quotes for the href value, given that the HTML standard (or at least norm) is to use double quotes.

jhodgdon’s picture

Status:Needs review» Needs work

David: Thanks for responding!

Good idea to fix up the help as you suggested. I also forgot to set it to "needs work" due to #16.

amitgoyal’s picture

Status:Needs work» Needs review
StatusFileSize
new2.78 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,665 pass(es).
[ View ]

@jhodgdon - Please review attached patch which can be successfully applied in current code. The #9 patch doesn't work with the current code.

Changes suggested in #17 are not relevant.

1) The "To follow a specific user's new and updated content" line in the patch context should move back to single quotes, given that it doesn't contain any single-quoted content.

It contains single-quoted content, user's.

2) I'm also curious why "" uses single quotes for the href value, given that the HTML standard (or at least norm) is to use double quotes.

As the section content is in double quotes in t() function so the '!recent' in href is in single quotes.

jhodgdon’s picture

Status:Needs review» Needs work

@David Strauss - We asked a specific question in #9 about the Track page from the User account. Can you please respond?

Regarding #19, we should always use double quotes in href="" and other HTML attributes. This may mean that the patch needs to change t('') to use single quotes, and if there are apostrophes in the text, they can be escaped like

t('The user\'s tracker page...

amitgoyal’s picture

Status:Needs work» Needs review
StatusFileSize
new2.78 KB
PASSED: [[SimpleTest]]: [PHP 5.4 MySQL] 71,867 pass(es).
[ View ]
new1.51 KB

@jhodgdon - I have updated the patch as per the single / double quotes suggestion in #20.

Please review.

jhodgdon’s picture

We still need an answer for #9 before we can proceed in this patch, I think?

Anyway, the single/double quotes in the latest patch look good.

amitgoyal’s picture

StatusFileSize
new68.3 KB

@jhodgdon - Track tab is visible on user account page. Please see attached screenshot for reference.

jhodgdon’s picture

Issue summary:View changes
Issue tags:+Needs manual testing, +Novice

Oh good, thanks! I had not tested, was just asking for clarification based on previous comments.

In that case, this help looks good to me, and it is ready for a manual test:
- Verify that all the links work
- Verify that all mentions of pages/text/permissions within the UI match what is seen in the UI
- Verify that the formatting is OK.

jhodgdon’s picture

Issue summary:View changes

whoops, copy/paste error

mparker17’s picture

Looks like @David Strauss forgot to unassign it...

... I can help review it though!

mparker17’s picture

Issue summary:View changes
mparker17’s picture

Assigned:mparker17» Unassigned
Status:Needs review» Reviewed & tested by the community

Code looks good.

Manual testing shows all the links work and the terminology appears to be consistent with the rest of the help pages.

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed

Thanks again everyone! Committed to 8.x.

  • Commit 8ee9b1d on 8.x by jhodgdon:
    Issue #2091429 by amitgoyal, mparker17, batigolix, Mark Conroy: Update...

Status:Fixed» Closed (fixed)

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