Keep a DRY README.md for wordpress.org & Github #653
Conversation
There was a problem hiding this comment.
I'm not 100% sure this will work, but as I understood Mika Epstein correct, using the wpvideo shortcode works. But it doesn't look that nice on Github.
Sources:
- https://make.wordpress.org/plugins/2018/03/06/understanding-readme-txt/
- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/#videos
- https://wordpress.org/documentation/article/video-shortcode/
Tested if the wpvideo shortcode can use an external file from raw.github... which works. 👍
Bildschirmaufzeichnung.vom.04.05.2024.14.47.22.mp4
… within Github. This does not afect wp.org in any way.
…e to start contributing
carstingaxion
changed the title
|
Primary complaint from Readme Validator are missing screenshots, but that's not necessary for this PR but something certainly worth adding in via a separate PR. You can take the raw README.md from this PR and paste into WP Readme to see how things will render on WP.org. |
|
The images are here, but not yet decided. Thanks for referencing this nice tool and auditing this PR @jeffpaul |
There was a problem hiding this comment.
This looks good, @carstingaxion. Thx!
I think I'll also add to the CLI and a unit test to update and compare credits in a future PR so we can manage it in one place and let the script updated it everywhere. If you feel good with this, just move it from draft and we can merge it. Thx again!
|
Thank you @mauteri . I wanted to wait because @patriciabt and me had some more on the list in #406 And at least some images should be included in the README. |
|
But this should not be my decision. I'll open the draft for review and you @mauteri can decide with @patriciabt what to do when. Cheers. |
Cool, @patriciabt can you take a look and let me know if there's other things to add? I'm fine with how it is and we can add more in another PR if need be. Thx! |
|
Maybe we could add another FAQ Question to the bottom of the list, like:
As a Community powered plugin, GatherPress is already the PRO-version. Because we strive for close-to-core development, love decisions - not options and follow a lot of well known best-practices within the WordPress space, we can and do focus on what matters most - powering communities. GatherPress‘ best-practices(each element with a relevant link to the standard or tool)
|
|
Oooops. And we missed out totally the Pilot Proposal. |
(I would suggest adding the following below the first paragraph.)
|
|
@carstingaxion @patriciabt @jeffpaul is there anything else that needs to be done in the README.md or any questions you have or can this be merged? Thx! |
I added one last comment on this. |
|
Made some changes and going to merge this. Let's review the README.md now completely rendered in GH and if there's any additional changes let's put in follow up PRs. Thx! |
README.md
Outdated
|
|
||
| This plugin leverages the following third-party libraries for various functionalities: | ||
|
|
||
| - [Moment.js](https://momentjs.com/): Used for date and time manipulation. |
There was a problem hiding this comment.
No need to mention as it is also in WordPress list.
README.md
Outdated
|
|
||
| ### What external services are used in GatherPress? | ||
|
|
||
| We utilize Open Street Maps to render meeting locations in a map form. In order to do so we send the address to OSM in order to render their map. |
There was a problem hiding this comment.
We should add Google maps to this as well as Yahoo! and Google calendar in the add to calendar functionality.
Description of the Change
Closes #406, Closes #610
How to test the Change
Changelog Entry
Credits
Props @mauteri , @jeffpaul , @patriciabt , @carstingaxion
Checklist: