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 doc links references to google-for-woocommerce #2486

Merged
merged 10 commits into from
Aug 5, 2024

Conversation

puntope
Copy link
Contributor

@puntope puntope commented Aug 2, 2024

Changes proposed in this Pull Request:

This PR replaces all the links pointing into https://woocommerce.com/document/google-listings-and-ads, https://woocommerce.com/document/google-for-woocommerce to

List of URLs Changed

https://woocommerce.com/document/google-listings-and-ads/#required-google-permissions (works in Old, anchor stop working in New)
Its now a new page here. https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#general-requirements

https://woocommerce.com/document/google-listings-and-ads/#contact-information (works in Old, anchor stop working in New)
Updated link :- https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#contact-information
https://woocommerce.com/document/google-listings-and-ads/#general-requirements (works in Old, anchor stop working in New)

updated link :- https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#general-requirements
https://woocommerce.com/document/google-listings-and-ads/#google-performance-max-campaigns (works in Old, anchor stop working in New)
It's a new page now. https://woocommerce.com/document/google-for-woocommerce/get-started/google-performance-max-campaigns/

https://woocommerce.com/document/google-listings-and-ads/#google-merchant-center-requirements (works in Old, anchor stop working in New)
updated link :- https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#google-merchant-center-requirements

https://woocommerce.com/document/google-listings-and-ads/#free-listings-on-google (works in Old, anchor stop working in New)
New page is here. https://woocommerce.com/document/google-for-woocommerce/get-started/product-feed-information-and-free-listings/#section-1

⚠️ https://woocommerce.com/document/google-listings-and-ads/#getting-started-with-campaign-analytics (anchor doesn't work)
Has a new page https://woocommerce.com/document/google-for-woocommerce/get-started/campaign-analytics/

⚠️ https://woocommerce.com/document/google-listings-and-ads/compliance-policy/ (in new, it redirects to old)
New page is here. https://woocommerce.com/document/google-for-woocommerce/compliance-policy-2/

⚠️ https://woocommerce.com/document/google-listings-and-ads/compliance-policy/#store-is-live (in new, it redirects to old)
updated Link is here. https://woocommerce.com/document/google-for-woocommerce/compliance-policy-2/#store-is-live

⚠️ https://woocommerce.com/document/google-listings-and-ads/compliance-policy/#complete-checkout (in new, it redirects to old)
updated link is here https://woocommerce.com/document/google-for-woocommerce/compliance-policy-2/#complete-checkout

⚠️ https://woocommerce.com/document/google-for-woocommerce/compliance-policy/#refund-and-terms (in new, it redirects to old)
updated link is here. https://woocommerce.com/document/google-for-woocommerce/compliance-policy-2/#refund-and-terms

⚠️ https://woocommerce.com/document/google-listings-and-ads-faqs
New page is here. https://woocommerce.com/document/google-for-woocommerce/faq/

Detailed test instructions:

  1. Check that there are no links left to https://woocommerce.com/document/google-listings-and-ads
  2. Check that the links were replaced correctly and they work.

Additional details:

Changelog entry

Tweak - Update doc links references

@puntope puntope self-assigned this Aug 2, 2024
@github-actions github-actions bot added the changelog: tweak Small change, that isn't actually very important. label Aug 2, 2024
@puntope puntope requested a review from a team August 2, 2024 07:06
@puntope puntope marked this pull request as ready for review August 2, 2024 07:06
Copy link

codecov bot commented Aug 2, 2024

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 64.6%. Comparing base (f398161) to head (679db10).
Report is 15 commits behind head on develop.

Files Patch % Lines
src/MerchantCenter/MerchantStatuses.php 0.0% 1 Missing ⚠️
src/Notes/SetupCampaign.php 0.0% 1 Missing ⚠️
src/PluginHelper.php 0.0% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             develop   #2486     +/-   ##
===========================================
+ Coverage       64.5%   64.6%   +0.1%     
- Complexity      4564    4575     +11     
===========================================
  Files            795     797      +2     
  Lines          22844   22898     +54     
  Branches        1220    1220             
===========================================
+ Hits           14739   14793     +54     
  Misses          7938    7938             
  Partials         167     167             
Flag Coverage Δ
js-unit-tests 63.5% <ø> (ø)
php-unit-tests 64.9% <0.0%> (+0.1%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
js/src/components/help-icon-button.js 33.3% <ø> (ø)
src/MerchantCenter/MerchantStatuses.php 76.5% <0.0%> (ø)
src/Notes/SetupCampaign.php 0.0% <0.0%> (ø)
src/PluginHelper.php 82.9% <0.0%> (ø)

... and 5 files with indirect coverage changes

Copy link
Contributor

@mikkamp mikkamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, I only found one location where we might want to change a link.

The rest are comments more related to the documentation itself, so we might need to follow up in a different location to get those changed. I also noticed that the breadcrumbs isn't very consistent:

image

image

@@ -21,7 +21,7 @@ import './request-full-access-google-account-card.scss';
* @param {string} props.additionalScopeEmail Specify the email to be requested additional permission scopes to Google.
* @fires gla_google_account_connect_button_click with `{ action: 'scope', context: 'reconnect' }`
* @fires gla_google_account_connect_button_click with `{ action: 'scope', context: 'setup-mc' }`
* @fires gla_documentation_link_click with `{ context: 'setup-mc-accounts', link_id: 'required-google-permissions', href: 'https://woocommerce.com/document/google-listings-and-ads/#required-google-permissions' }`
* @fires gla_documentation_link_click with `{ context: 'setup-mc-accounts', link_id: 'required-google-permissions', href: 'https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#general-requirements' }`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sending them to the right link here when they haven't accessed all scopes?

What about using https://woocommerce.com/document/google-for-woocommerce/get-started/setup-and-configuration/#required-google-permissions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Changed here 679db10

@@ -23,7 +23,7 @@ import StoreAddressCard from '.~/components/contact-information/store-address-ca

const learnMoreLinkId = 'contact-information-read-more';
const learnMoreUrl =
'https://woocommerce.com/document/google-listings-and-ads/#contact-information';
'https://woocommerce.com/document/google-for-woocommerce/get-started/requirements/#contact-information';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know how valid this link is for the store address. This also adds the store address to the Merchant Account, but isn't made public. This also doesn't fulfil the public contact information requirement.
I think we need to either separate the contact information section into two parts or include a mention about the contact address and phone number being added to the Merchant Center account.

The two separate parts would be:

  1. Contact information synced with Merchant account (phone + store address)
  2. Requirement to have at least one type of public contact information on your site (contact us page)

Should the second part be on the compliance policy page: https://woocommerce.com/document/google-for-woocommerce/compliance-policy-2

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mikkamp Not sure if I fully understand this. Can you elaborate?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant because it's mixing both contact details that should be on your site and public and then also contact details which should be sent to Merchant Center it's a bit confusing what part belongs to this learnMore link. But reading it again, it does still provide the required information so maybe we can just leave it for now.

@puntope
Copy link
Contributor Author

puntope commented Aug 3, 2024

Thanks for the changes, I only found one location where we might want to change a link.

The rest are comments more related to the documentation itself, so we might need to follow up in a different location to get those changed. I also noticed that the breadcrumbs isn't very consistent:

image

image

I don't think we can change that in this PR so I will ping for updating the docs.

Copy link
Contributor

@mikkamp mikkamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes. I'll go ahead and approve this PR as the rest will need to be changed in the docs itself and isn't blocking this PR.

@puntope puntope merged commit 81caa3e into develop Aug 5, 2024
15 checks passed
@puntope puntope deleted the tweak/update-doc-links branch August 5, 2024 13:29
@ianlin ianlin mentioned this pull request Aug 6, 2024
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: tweak Small change, that isn't actually very important.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants