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

Upgrade Readme FAQ and remove video for wporg #2497

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Conversation

puntope
Copy link
Contributor

@puntope puntope commented Aug 6, 2024

Changes proposed in this Pull Request:

This PR upgrades readme.txt for changing WP.org plugin page

Screenshots:

Screenshot 2024-08-06 at 19 29 32 Screenshot 2024-08-06 at 19 29 27

Detailed test instructions:

  1. Check the readme in https://wordpress.org/plugins/developers/readme-validator/ (potentially you need to change the name because the validator doesn't support some keywords)
  2. Check the readme visually in https://wpreadme.com/ (especially faq)
  3. Check the readme in comparison with https://woocommerce.com/products/google-listings-and-ads/ (notice the links points to the new docs using google-for-woocommerce structure)

Additional details:

Changelog entry

Tweak - Update WP.org plugin FAQs

@puntope puntope self-assigned this Aug 6, 2024
@puntope puntope requested a review from a team August 6, 2024 17:31
@github-actions github-actions bot added the changelog: tweak Small change, that isn't actually very important. label Aug 6, 2024
@puntope puntope marked this pull request as ready for review August 6, 2024 17:32
@puntope puntope changed the title Upgrade Readme FAQ and remove video for wp.org Upgrade Readme FAQ and remove video for wporg Aug 6, 2024
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, this looks good to me. And still validates fine in the readme validator: https://wordpress.org/plugins/developers/readme-validator/

I just left one question about HTML markup. Is the banner image going to be changing on this page, or is that part of a separate PR?

If you’re selling in the US, then eligible free listings can appear in search results across Google Search, Google Images, and the Google Shopping tab. If you're selling outside the US, free listings will appear on the Shopping tab.
= What is Product Sync? =
Product Sync is a feature fully integrated into WooCommerce’s management platform that automatically lets you sync your product feed to Google Merchant Center. It will sync all your WooCommerce product data, and you can also add or edit products individually or in bulk. To ensure products are approved by Google, check that your product feed includes the following information:
<p> <br> </p>
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 sure this line is going to be parsed correctly? The readme.txt file should be in markdown, I don't see any mention of how html tags are parsed. Would the formatting get mixed up if we just leave this line out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point @mikkamp. The reason of this line is that the list miss the margin and looks very close to the paragraph. With that line, it seems to be good.

Screenshot 2024-08-08 at 10 47 26 Screenshot 2024-08-08 at 10 47 32

Copy link
Contributor

Choose a reason for hiding this comment

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

Hopefully that gets parsed correctly then.

@puntope
Copy link
Contributor Author

puntope commented Aug 8, 2024

Is the banner image going to be changing on this page, or is that part of a separate PR?

New PR

@puntope puntope merged commit 6ba28b4 into develop Aug 8, 2024
4 checks passed
@puntope puntope deleted the tweak/wporg-readme branch August 8, 2024 08:52
@eason9487 eason9487 mentioned this pull request Aug 14, 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