site-kit-wp: Add a "get help" link to the "reconnect_after_url_mismatch" notice.

Feature Description

We need to add a new “Get Help” link to the notification that appears when site has changed its URL. The URL for the new “get help” link should be obtained using the getDocumentationLinkURL selector introduced in https://github.com/google/site-kit-wp/issues/5423.

https://github.com/google/site-kit-wp/blob/16a446a84e4f111b75dd951f26e542dc2ebd3758/includes/Core/Authentication/Authentication.php#L1110-L1117


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • The “reconnect after url mismatch” notification should display a new “Get Help” link that leads to the {proxy}/support/?doc=url-has-changed URL.

Implementation Brief

Test Coverage

  • Verify the Setup -> Using Proxy with Sign-in -> Disconnected - URL Mismatch stories.
  • Update VRT images if required.

QA Brief

  • Locate the Setup -> Using Proxy with Sign-in -> Disconnected - URL Mismatch story in storybook
  • Verify that a new Get help-link has been added below the description
  • Verify that the link opens in a new tab and that the URL is <proxiedSupportURL>/?doc=url-has-changed

  • Create a new site and sign in with Site Kit.
  • Change the URL of the site so Site Kit shows the “URL Mismatch notice” when accessing the dashboard.
  • Verify there is now a “Get help” link beneath the URL mismatch notice message and it opens a ?/doc=url-has-changed link in a new tab.

Changelog entry

  • Add a help link to the “site URL has changed” notice when Site Kit detects your site URL has changed.

About this issue

  • Original URL
  • State: closed
  • Created 2 years ago
  • Comments: 17 (1 by maintainers)

Commits related to this issue

Most upvoted comments

IB ✔️

Thank you @eugene-manuilov! I’ve updated the IB so that the Get Help link appears right after the Reconnect link.

  • add a new <p> tag containing a <Link> component.

Same here, no need to put it into a separate <p> tag. It should go in the same paragraph.

Thanks, @nfmohit. Mostly looks good to me. Have a few comments:

extend the $content variable with concatenation and include a new <p> tag containing a link (<a>) tag.

No need to put the new link into a separate <p> tag, it will make the link appear below the notice message. We need to add the get help link after the reconnect one.

  • Use the getDocumentationLinkURL selector with the slug url-has-changed from the core/site store and assign it in a variable named alreadyConfiguredGetHelpLink (or something more relevant).

How about urlHasChangedHelpLink?