Update plugin readme.txt content for intended audience
#38724
Conversation
github-actions
bot
added
the
First-time Contributor
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @ironprogrammer! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
gziolo
added
[Type] Developer Documentation
…ugin-description-update
Gives users a taste of the block editor before committing to installation.
imho it is good to end the main description with a call for contributors.
Also break up into separate paragraphs.
|
Thank you, @annezazu and @priethor for your review feedback! These latest updates address the following:
|
|
Thanks for looping back to make changes!
I think this will be a bit misleading potentially since Gutenberg is integrated into WordPress releases and the experience there matches what they would get regardless. It's also in the process of being updated: https://meta.trac.wordpress.org/ticket/5600#ticket |
|
In response to @annezazu:
Gotcha -- if the demo is an outdated representation, then we shouldn't reference it at this time. I've pulled that item out of the list (8bcba28). Assuming the demo site gets updated 🤞🏻, this is a topic for future consideration, but I would like to understand more:
Could you explain as to why it would be misleading? The intention in referencing the demo is to allow users to see/touch/tinker with Gutenberg (the beta features) prior to committing to installation of the plugin -- not to try the approved/backported features in WordPress's built-in editor. Since demos are a widely accepted practice in the plugins and themes directories, why would we not utilize it (after a refresh) to help educate users? Demos address so many intangibles that can't be adequately conveyed through the plugin description. Making this accessible without installation would be beneficial to anyone interested in the plugin. My apologies 🙏🏻 if the demo is NOT actually supposed to be Gutenberg, but is instead simply the backported features in WP's editor! |
…ugin-description-update
The demo is very basic and only shows off features that are currently available in WordPress today. Back when Gutenberg was new, it was more cutting edge and would have made sense to include then. Now though, it's not kept up to date with regularity and does not show "coming soon" features in the current state. This is why it feels a bit odd to direct someone to a demo page that includes what comes baked into WordPress. Does that make more sense? |
|
In response to @annezazu:
Yes, thank you! One day I'll get it in my head that Gutenberg isn't just the plugin/beta feature set! |
…8724) * Add links to intro paragraph * Rearrange main content into "what does it do" section * Adds "who is this for" section * Capitalizes Slack * Breaks feedback faq into paragraphs for readability * Breaks "do I need" section into paragraphs and answers question more directly * Adjusts capitalization and smart quote * Add link to 2021 SotW post * Adjust capitalization for consistency * Add section covering 1-star reviews * Add FAQ reference to Classic Editor * Removes Classic Editor FAQ * Removes 1-star reviews FAQ * Add test drive link Gives users a taste of the block editor before committing to installation. * Move introduction date below intro paragraph * Move explainer higher in content * Change heading to focus on benefit * Add section with focus on contributors * Remove reference to running in production * Add more reference to contribution imho it is good to end the main description with a call for contributors. * Add reference to FSE * Add reference to FSE and additional block types Also break up into separate paragraphs. * Move test drive to top of list; works better in context of this list * Remove demo link; page is outdated and updates under consideration * Clarify that Gutenberg IS the WordPress editor * Remove confusing reference to WordPress editor; just call it Gutenberg
Description
This PR proposes updates to the plugin
readme.txtfile. Most of these changes are intended to more clearly communicate that Gutenberg is beta software, subject to frequent and unexpected changes, and not intended for production sites.It is anticipated that added clarity to the plugin page might decrease emotionally charged low ratings and forum feedback, and deter installations in environments that are not appropriate for beta testing. It is our objective to instead focus plugin testers' attention on opportunities to contribute toward the betterment of block editing in WordPress, and to provide constructive feedback.
Updates Include:
Add FAQ item related to 1-star ratings.Add FAQ reference to the Classic Editor, which is commonly sought after as an alternative to Gutenberg or the block editor.References:
Testing Instructions
n/a
Types of changes
readme.txt.Checklist:
Acknowledgements
Props @annezazu for encouraging me to provide this feedback in traceable capacity that may help impact the community in a positive way! 😊