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

Audit blocks for writing and contentOnly modes #40040

Open
4 tasks
Tracked by #39818
annezazu opened this issue Nov 4, 2024 · 8 comments
Open
4 tasks
Tracked by #39818

Audit blocks for writing and contentOnly modes #40040

annezazu opened this issue Nov 4, 2024 · 8 comments
Labels
Epic Formerly "Primary Issue", or "Master Issue" [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Janitorial

Comments

@annezazu
Copy link

annezazu commented Nov 4, 2024

Similar to the work being done in Core to audit blocks for the new Write mode, I wanted to kick off an issue to do the same for Jetpack blocks as they are greatly embedded on WordPress.com and in the wider WordPress ecosystem and it would be ideal for these blocks to be prepared for this feature sooner rather than later. As a reminder, Write mode seeks to offer a simplified editing experience where the focus is on content related changes with only section level styling options available.

For more information:

Please add and edit this issue as you find more Jetpack blocks that need to be updated.

Blocks

Contact Form

  • User cannot edit the field text

Subscribe

  • User cannot edit the placeholder text

Contact info

  • User cannot edit any field text, whether edited or not

Paid content

  • User cannot edit any buttons
@annezazu annezazu added [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it labels Nov 4, 2024
@jeherve jeherve added [Type] Janitorial Epic Formerly "Primary Issue", or "Master Issue" [Pri] Normal [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ and removed [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it labels Nov 5, 2024
@jeherve
Copy link
Member

jeherve commented Nov 5, 2024

Thanks for creating this Epic! Is there any chance you could add a bit of context about this new Write mode? I looked around a bit but couldn't find a dev note or an Epic in the Gutenberg repo, highlighting the changes and how we can adapt to it.

Thank you!

@jeherve jeherve added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Nov 5, 2024
@simison
Copy link
Member

simison commented Nov 5, 2024

Subscribe
User cannot edit the placeholder text

It's not possible to edit placeholder text at block canvas in any mode, but is it still available to edit via sidebar?

@annezazu
Copy link
Author

annezazu commented Nov 5, 2024

Thanks for creating this Epic! Is there any chance you could add a bit of context about this new Write mode? I looked around a bit but couldn't find a dev note or an Epic in the Gutenberg repo, highlighting the changes and how we can adapt to it.

Here's the broader vision: WordPress/gutenberg#60021 There currently isn't a dev note in place as it's not landing for 6.7 but planned for 6.8. Check out the in progress tutorial for the official dev blog for now though: WordPress/developer-blog-content#303

It's not possible to edit placeholder text at block canvas in any mode, but is it still available to edit via sidebar?

I'm referring to when you are in Write mode :) That option goes away.

@jeherve
Copy link
Member

jeherve commented Nov 5, 2024

Here's the broader vision: WordPress/gutenberg#60021 There currently isn't a dev note in place as it's not landing for 6.7 but planned for 6.8. Check out the in progress tutorial for the official dev blog for now though: WordPress/developer-blog-content#303

Thanks, that helps!

May I suggest adding the "[Feature] Write mode" label to that issue? I think I missed it because I was using the label to filter through issues.

@jeherve jeherve removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Nov 5, 2024
@annezazu
Copy link
Author

annezazu commented Nov 5, 2024

Done! Thanks for calling that out.

@jeherve
Copy link
Member

jeherve commented Nov 6, 2024

@annezazu This may be a stupid question, but how is this new method supposed to work? I read about it, then played with it a bit and it seems I cannot really add any blocks when in Write mode. Would I add blocks when in Design mode, and then go to Write mode and update them? And in our audit, we would want to make sure all our blocks, once added, can still have their contents (such as placeholders or any field) be editable when in Write mode?

If we take the Contact Form feature for example, what would the expected workflow be? Would I be expected to use Write Mode when creating or editing a form? If so, what would be the expected steps? Add the parent block in design mode, add the child blocks (each field) in design mode, and then enter Write mode and change the contents of the different fields I created?

@annezazu
Copy link
Author

annezazu commented Nov 7, 2024

Not a stupid question at all and part of the "dance" we're trying to figure out in Core.

I read about it, then played with it a bit and it seems I cannot really add any blocks when in Write mode. Would I add blocks when in Design mode, and then go to Write mode and update them?

Yes, as it stands, you cannot add new blocks in this mode and you'd have to switch between them. There is a very early convo happening around the possibility of adding inner blocks in the future Add new mode to contentOnly locking to allow insertion of new inner blocks. This would be great to chime in on if you think it would benefit Jetpack.

And in our audit, we would want to make sure all our blocks, once added, can still have their contents (such as placeholders or any field) be editable when in Write mode?

All of the blocks that makes sense. For Core, for example, we're having to reconsider what this mode looks like when it comes to both navigation and the query loop blocks. You all might have similar use cases and can likely follow along to see how we approach things in Core.

If we take the Contact Form feature for example, what would the expected workflow be? Would I be expected to use Write Mode when creating or editing a form? If so, what would be the expected steps? Add the parent block in design mode, add the child blocks (each field) in design mode, and then enter Write mode and change the contents of the different fields I created?

In this case, I would think of it more as someone adds a pattern with the Jetpack contact form block in it onto a new "Contact me" page and they have this mode on. They then are trying to edit and build out the form, focused just on the copy and any high level styling options.

On the flip side, we also need to consider someone adding this block in. Since you can't add blocks in Write mode, you can imagine someone adding it in Design mode and then later switching to Write mode in order to simplify the editing experience. Does that make sense?

Keep sharing as this is helpful feedback!

@annezazu
Copy link
Author

annezazu commented Nov 8, 2024

To follow up, here's the developer blog post about this contentOnly option 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Formerly "Primary Issue", or "Master Issue" [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Janitorial
Projects
None yet
Development

No branches or pull requests

3 participants