Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all "Learn More" links to use the new /support/?doc= approach. #5485

Closed
eugene-manuilov opened this issue Jun 30, 2022 · 7 comments
Closed
Labels
Good First Issue Good first issue for new engineers P1 Medium priority Type: Enhancement Improvement of an existing feature

Comments

@eugene-manuilov
Copy link
Collaborator

eugene-manuilov commented Jun 30, 2022

Feature Description

We need to update all "Learn More" links in the plugin to use the new approach for support links that requires using {proxy}/support/?doc={slug} URLs instead of direct links to the documentation site. This approach will allow us to decouple the plugin codebase from actual documentation pages and shift routing responsibility on the proxy service shoulders.

The new "learn more" URLs should be computed using the new getDocumentationLinkURL selector introduced in #5423.


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

Acceptance criteria

Implementation Brief

  • All the files that use the hard-coded links for Learn more / Learn more ... should be updated using the getDocumentationLinkURL() selector of the CORE_SITE store.
  • The slug parameter for the getDocumentationLinkURL() selector should be taken from the first column of the spreadsheet that matches the existing hardcoded URLs.

Test Coverage

  • No new tests are to be added.

QA Brief

  • Browsing the plugin, no support links (eg. links with "Learn more" text) should have href values that point directly to https://sitekit.withgoogle.com/documentation. Instead, learn more links should point to https://sitekit.withgoogle.com/support?doc=.

Changelog entry

  • Update support documentation links to use the new URL structure.
@eugene-manuilov eugene-manuilov added P1 Medium priority Type: Enhancement Improvement of an existing feature labels Jun 30, 2022
@felixarntz
Copy link
Member

@eugene-manuilov ACs LGTM, however can you make the slugs from that doc all lowercase? This may be by accident anyway, but it would be a bit of a weird convention to have some start with a capital letter.

@eugene-manuilov
Copy link
Collaborator Author

Thanks, @felixarntz. Slugs are updated. Moving this ticket to IB.

@hussain-t hussain-t assigned hussain-t and unassigned hussain-t Jul 8, 2022
@eugene-manuilov eugene-manuilov self-assigned this Jul 11, 2022
@eugene-manuilov
Copy link
Collaborator Author

IB ✔️

@eugene-manuilov eugene-manuilov removed their assignment Jul 11, 2022
@eugene-manuilov eugene-manuilov added the Good First Issue Good first issue for new engineers label Jul 11, 2022
@maciejost maciejost assigned maciejost and unassigned maciejost Jul 18, 2022
@tofumatt tofumatt self-assigned this Jul 19, 2022
@tofumatt tofumatt removed their assignment Jul 28, 2022
@techanvil techanvil assigned techanvil and tofumatt and unassigned techanvil Jul 29, 2022
@tofumatt tofumatt assigned techanvil and unassigned tofumatt Aug 3, 2022
@techanvil techanvil removed their assignment Aug 3, 2022
@mohitwp mohitwp self-assigned this Aug 4, 2022
@mohitwp
Copy link
Collaborator

mohitwp commented Aug 9, 2022

QA Update ⚠️

@tofumatt @eugene-manuilov

cc @wpdarren

@tofumatt
Copy link
Collaborator

tofumatt commented Aug 9, 2022

I found that 2 slugs under doc are not redirects of 'Learn more' they are basically 'Get help' redirects - 'adblocker detected ' and 'url-has-changed'.

Do you mean the text for these URLs is "Get help" instead of "Learn more"? If so, that is fine. The URLs still work as expected, right?

Also, I'm not sure how can I create scenario to get notification about 'url-not-part-of-this-site' and staging which are mentioned in https://docs.google.com/spreadsheets/d/19dgLTylSt6rbBDZi5yiIYuCbuHA75KLjZMgAwlwfYBg/edit . Can you please guide me how can I get 'Learn more' link for these two cases?

For these two errors ("URL not part of this site" and "staging") I'd say this can be skipped as the process to trigger that error is very niche and the code for it is exactly the same as the rest of the changes. To be honest I'm not even sure of the exact QA steps to get there right now, but if the rest of the changes worked without issue than this can be QA'd.

@tofumatt tofumatt assigned mohitwp and unassigned mohitwp and tofumatt Aug 9, 2022
@mohitwp
Copy link
Collaborator

mohitwp commented Aug 11, 2022

I found that 2 slugs under doc are not redirects of 'Learn more' they are basically 'Get help' redirects - 'adblocker detected ' and 'url-has-changed'.

Do you mean the text for these URLs is "Get help" instead of "Learn more"? If so, that is fine. The URLs still work as expected, right?

Yes, these 'get help' links also working as expected.

@mohitwp
Copy link
Collaborator

mohitwp commented Aug 11, 2022

QA Update ✅

Idea hub:

image

Fix common issues:

image

dashboard-sharing

image

ga4:

image

not-enough-traffic :

image

already configured :

image

staging :

image

@mohitwp mohitwp removed their assignment Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good first issue for new engineers P1 Medium priority Type: Enhancement Improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

7 participants