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

Proposal: remove the development-only warning #482

Merged
merged 2 commits into from
Dec 6, 2023
Merged

Conversation

vcanales
Copy link
Member

It feels like the warning might be a deterrent for some folks. While it's true that the plugin is intended for the development of themes, it doesn't seem like there's a risk behind installing the plugin in a production site, or, if there are any — eg. if the plugin would replace the active theme — we should warn the user before the action is taken.

It feels like the warning might be a deterrent for some folks. While
it's true that the plugin is intended for the development of themes, it
doesn't seem like there's a risk behind installing the plugin in a
production site, or, if there are any — eg. if the plugin would replace
the active theme — we should warn the user before the action is taken.
@vcanales vcanales added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 28, 2023
@pbking
Copy link
Contributor

pbking commented Nov 28, 2023

Without CBT changes to themes can be reversed, all the way back to the theme's design when it was installed.

With CBT installed it's possible for a user to "save" the Theme at which point the only way to "undo" those changes is to re-install the theme. It feels like an important step and, even with a "warning" on the "save" step still doesn't seem like enough of a potential deterrent.

I do think that, generally speaking, CBT doesn't belong on a production website, especially with people who might have permissions to use the Site Editor but not the understanding not to use CBT when they do.

@vcanales
Copy link
Member Author

With CBT installed it's possible for a user to "save" the Theme at which point the only way to "undo" those changes is to re-install the theme. It feels like an important step and, even with a "warning" on the "save" step still doesn't seem like enough of a potential deterrent.

We might want to make it so that this is not necessarily the case?

I do think that generally speaking, CBT doesn't belong on a production website.

I agree with this, and at the same time feel like we could write a better warning that doesn't make it feel like the plugin itself is in development mode. Maybe turn the message from a warning into something more encouraging, such as "This plugin is intended to be "Developer Mode" for WordPress/the Site Editor" (based on an IRL conversation I had yesterday).

@pbking
Copy link
Contributor

pbking commented Nov 30, 2023

I agree with this, and at the same time feel like we could write a better warning that doesn't make it feel like the plugin itself is in development mode. Maybe turn the message from a warning into something more encouraging, such as "This plugin is intended to be "Developer Mode" for WordPress/the Site Editor" (based on an IRL conversation I had yesterday).

Good point, I see what you're saying. Less "this is unstable and thus shouldn't be in production" and more "this enables development features and thus is a tool that should be treated like that".

@vcanales
Copy link
Member Author

I've adjusted the warning to:

Disclaimer: Create Block Theme enables development features and thus is a tool that should be treated like as such; you can think of it as a Development Mode for WordPress, and you should keep in mind that changes made through this plugin could change your site and/or theme permanently.

Feel free to suggest or commit changes.

Copy link
Contributor

@pbking pbking left a comment

Choose a reason for hiding this comment

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

I like that a lot better than warning not to use it in production (which I agree makes it sound unstable, which isn't the point) or removing the statement completely (which doesn't warn of anything).

I think this seems like good wording.

🚢

Copy link
Member

@mikachan mikachan left a comment

Choose a reason for hiding this comment

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

I agree, I like this wording too 👍

@vcanales vcanales merged commit 017d520 into trunk Dec 6, 2023
1 check passed
@vcanales vcanales deleted the try/update-docs branch May 23, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants