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

Comunicate Gutenberg Version Requirements #6171

Closed
pbking opened this issue Jul 7, 2022 · 5 comments
Closed

Comunicate Gutenberg Version Requirements #6171

pbking opened this issue Jul 7, 2022 · 5 comments
Labels
[Type] Enhancement New feature or request

Comments

@pbking
Copy link
Contributor

pbking commented Jul 7, 2022

What problem does this address?

Some of the newer themes leverage features of Gutenberg that are not yet available in WordPress core. This isn't communicated in the WordPress.org directory and the theme might seem broken.

What is your proposed solution?

Those themes should be identified and that dependency communicated, likely in the readme.txt file. While it's expected that every thing should WORK without the plugin it's reasonable that not every feature implemented will work as expected without the plugin activated.

A good example of this is the "elements" api changes that allow us to define styles for state selectors. This is a particular boon for buttons and links and allows a lot less CSS to be used. However the result is that unless Gutenberg is activated those styles won't be used.

This situation should be communicated to anyone using the theme in the WordPress.org space.

Previously we tinkered with the idea of programmatically testing for the plugin, or testing for features and communicating that once the theme is activated (in wp-admin). This was both heavy handed and didn't well communicate the situation.

Suggestion for inclusion in the theme readme.txt file:

This theme was developed using the Gutenberg plugin v13.0.0, some elements may not work or appear as expected without that version or higher installed

This could be removed once the latest version of WordPress contains the features.

@kathrynwp kathrynwp added the [Type] Enhancement New feature or request label Jul 7, 2022
@jffng
Copy link
Contributor

jffng commented Jul 7, 2022

Thanks for the background and context, useful to remind me why we removed the requires Gutenberg programmatic checks.

I think adding a statement to the readme makes sense, though I'm not sure about adding it right in the description.

What do you think about placing it here: https://github.com/Automattic/themes/pull/6164/files#diff-0b916d65cce624bd0913dfdd33184e0c7d447f9ae8cae0a6cb9695680e26e7f5R14-R17

@pbking
Copy link
Contributor Author

pbking commented Jul 8, 2022

Yea, I can get behind that. I agree that putting it right in the description is probably more 'in your face' than necessary and would spread that bit of text further than is helpful. I think that makes the most sense.

@pbking
Copy link
Contributor Author

pbking commented Jul 8, 2022

I'm mostly thinking about the elements API and the version requirements around that, but are there other features that we've leaned on Gutenberg for in recent releases that we should also tag in themes?

@jffng
Copy link
Contributor

jffng commented Jul 8, 2022

I feel like they are often one-off design tool additions we need to make a specific block look correct without adding CSS, for example:

WordPress/gutenberg#41378

@pbking
Copy link
Contributor Author

pbking commented Nov 10, 2022

Closing this as I no longer believe we need a standard way to communicate this and "latest" should be assumed enough.

@pbking pbking closed this as completed Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants