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
Add requirements to meet WordPress.org block directory guidelines #63
Conversation
I _think_ this is closer to what WordPress.org is looking for
@jeffpaul My main concern is the custom REST endpoint. And we would need to remove the settings page. Because there can be no UI outside the editor |
@fabiankaegy yes, the "no PHP" stance is a current issue for us though I'm discussing with folks over in core about this in cases for blocks that need some setup/config steps that ideally happens in a Settings page. I know that the Plugin Review Team can add a block plugin to the Block Directory themselves, so I'm hoping our case at worst is an exception to the rule until the Gutenberg team is able to provide a better way to handle block setup/config akin to a Settings page. For now let's keep our settings as-is and only change if the Plugin Review Team and Gutenberg team say we must change. |
@fabiankaegy @ryanwelcher I could use your help in confirming the styles/scripts to reference in the block.json file, noting details on these potential four entries starts here: https://github.com/WordPress/gutenberg/blob/master/docs/rfc/block-registration.md#editor-script |
Sharing a screenshot from @fabiankaegy of request changes, I'll update for these now. |
Per https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/block-api/block-metadata.md it looks like we'll need to keep the |
Description of the Change
#62 outlines what's needed fairly well, this PR adds the
block
tag toreadme.txt
and theblock.json
file. I'm leaving this as a draft PR as theblock.json
still needs the scripts/styles added to the end of it as well as validating all other fields that I've attempted to complete. Note that there's duplication of theattributes
andicon
in theblock.json
with other places in the plugin codebase as I copied those values into theblock.json
file, I'm not certain if we can or should remove other references as the block submission guidelines and other details are still a bit in flux.Alternate Designs
n/a
Benefits
Ensures that this plugin appears in the Block Directory search within Gutenberg.
Possible Drawbacks
Given that we've got PHP code for the Settings page, we may need to get manual approval from the Plugin Review Team as there's supposed to be minimal-to-no PHP code in "block plugins".
Verification Process
TBD as this is still WIP, haven't verified anything fully yet.
Checklist:
Applicable Issues
Closes #62.
Changelog Entry