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

Eliminate readme.txt in favor of just README.md #5807

Merged
merged 14 commits into from
Jan 25, 2021

Conversation

westonruter
Copy link
Member

@westonruter westonruter commented Jan 24, 2021

Fixes #5791

  • Move WordPress assets from wp-assets to .wordpress-org.
  • Remove readme.txt in favor of README.md.
  • Update README.md to have the required format for the WordPress Plugin Directory.
  • Add vector logo.svg to go alongside the rasterized PNG logos.
  • Update all root markdown files to have the upper-case filename convention (e.g. CONTRIBUTING.md instead of contributing.md).
  • Add embedded video from video series and link to full playlist: image

@westonruter westonruter added this to the v2.1 milestone Jan 24, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jan 24, 2021

Plugin builds for 2f999e3 are ready 🛎️!

@westonruter westonruter requested a review from pierlon January 24, 2021 21:54
@westonruter
Copy link
Member Author

Ideally we'd rename readme.md to README.md for consistency with the other markdown files, but I haven't been able to confirm that this is supported.

@westonruter westonruter changed the title Eliminate readme.txt in favor of just readme.md Eliminate readme.txt in favor of just README.md Jan 24, 2021
@westonruter
Copy link
Member Author

Ideally we'd rename readme.md to README.md for consistency with the other markdown files, but I haven't been able to confirm that this is supported.

And this works! I tested it on another plugin: https://johnblackbourn.com/readme-md-plugin-on-wordpress-org/#comment-43918

@westonruter westonruter requested a review from amedina January 24, 2021 23:32
.dev-lib Outdated

README_MD_TITLE="AMP Plugin for WordPress"
ASSETS_DIR=wp-assets
# This is used by wp-dev-lib/scripts/check-diff.sh but the functionality is no longer used, so it could be removed.
Copy link
Contributor

Choose a reason for hiding this comment

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

This file could now be removed, along with the xwp/wp-dev-lib dependency since it's not being used anywhere else.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed in 2f999e3

Copy link
Member Author

Choose a reason for hiding this comment

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

This will require updating the Engineering Guidelines wiki page as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

bin/amphtml-update.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

This official plugin from the AMP project enables AMP content publishing with WordPress in a way that is fully and seamlessly integrated with the standard mechanisms of the platform.

https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this be embeddable on wp.org? GitHub doesn't render it appropriately:

image

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, see https://make.wordpress.org/core/2010/02/20/plugins-can-now-include-videos-in-their-readme-txt-files/

It previews as expected on https://wpreadme.com/

image

I've added videos like that before in readmes. Actually, wp-dev-lib supports that in transforming readme.txt to readme.md (at least in shortcode form):

https://github.com/xwp/wp-dev-lib/blob/a62ccca94f9995f294e12d500c45856adff81e34/scripts/class-wordpress-readme-parser.php#L97-L99

It's unfortunate that the bare URL in the README.md here would not be rendered on GitHub, but it seems like an acceptable tradeoff.

Copy link
Member Author

Choose a reason for hiding this comment

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

We could could contribute up to the WordPressdotorg\Plugin_Directory\Markdown class the ability to transform something more markdown-friendly into the bare URL that would be the YouTube embed.

For example, let's say that the README.md had this line:

[![Play video on YouTube](https://i1.ytimg.com/vi/s52JNMT59s8/hqdefault.jpg)](https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb)

This would be rendered on GitHub as:

Play video on YouTube

But then the Markdown class could transform any such YouTube-linked images to unwrap top the bare URL:

https://www.youtube.com/watch?v=s52JNMT59s8&list=PLXTOW_XMsIDRGRr5QDffrvND8Qh1RndFb

Then on WordPress.org the oEmbed would render, whereas on GitHub there would be a poster image linked to the video on YouTube.

Copy link
Contributor

Choose a reason for hiding this comment

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

That sounds like a great idea!

Copy link
Member Author

Choose a reason for hiding this comment

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

Filed a ticket requesting this: https://meta.trac.wordpress.org/ticket/5582

.wordpress-org/logo.svg Outdated Show resolved Hide resolved
@westonruter westonruter merged commit e605767 into develop Jan 25, 2021
@westonruter westonruter deleted the eliminate/readme.txt branch January 25, 2021 04:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Eliminate readme.txt in favor of just readme.md
2 participants