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

6.3 Dev Note Tracking Issue #51484

Closed
24 tasks done
Leonardus-Nugraha opened this issue Jun 14, 2023 · 27 comments
Closed
24 tasks done

6.3 Dev Note Tracking Issue #51484

Leonardus-Nugraha opened this issue Jun 14, 2023 · 27 comments
Assignees
Labels
[Type] Developer Documentation Documentation for developers [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.

Comments

@Leonardus-Nugraha
Copy link

Leonardus-Nugraha commented Jun 14, 2023

Tracking all Dev Notes from Gutenberg plugin releases 15.2 - 16.1

Please read the information below carefully. If you have questions, connect with @Leonardus-Nugraha or @stevenlinx via Slack or comment here.

Not all developer-related information needs to be in a separate DevNote on the Make Core blog for the field guide. We can group related information. We can already make decisions on some features if it warrants a stand-alone blog post or if the information will be part of a group post.

Stand-alone post

To streamline the process and eliminate bottlenecks, all writers of stand-alone dev notes will write the dev notes on the Make Core Blog. If you need access to write on the Blog, connect with @hellofromtonya or @abhansnuk via Slack or comment here.

Instructions

- Create your note in a new post, - Save as Draft - Enable public preview - Share the link to the public preview in a comment below, as "ready for review" - "For dev notes, each one must have at least two reviewers" ([Handbook](https://make.wordpress.org/core/handbook/tutorials/writing-developer-notes/))
## Part of a group post If the information related to your PR will be part of a group post, please write the **dev note in a comment on the PR**, so it can be reviewed and, if necessary commented on, by the release docs team or a reviewer.

Before you start writing 📣 please read the handbook pages:

- ⭐️ [Writing developer notes](https://make.wordpress.org/core/handbook/tutorials/writing-developer-notes/) - ⭐️ [Style & Substance section](https://make.wordpress.org/core/handbook/best-practices/post-comment-guidelines/#style-and-substance) of the Post & Comment Guidelines for Make Blog - ⭐️ [Documentation Style Guide](https://make.wordpress.org/docs/style-guide/) - Good for reference, when in doubt, especially when English is not your native language.

The list is incomplete. We are in the process of reviewing plugin release changelogs and add them as we progress on the task.

There are two labels:
needs dev note and has dev note

If you worked on a feature/module/component that definitely needs a dev note, please assign the label needs dev note If you already added the Dev Note to the make blog on draft or as a comment on the PR, please label it has dev note


Standalone dev notes:

Command Palette API

Block Selectors API

Layout-related updates

Social Icons

Miscellaneous dev notes:

To Do

Editor

Blocks

Patterns

Data

@Leonardus-Nugraha Leonardus-Nugraha added [Type] Developer Documentation Documentation for developers [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues. labels Jun 14, 2023
@noahtallen
Copy link
Member

The dev note I added under #49649 doesn't just apply to plugins, but it's a small enough change that I don't think it needs a separate post.

@kevin940726
Copy link
Member

Added dev note in #49673 (comment) for the relevant part of the PR. LMK if there's anything else I should include! 🙇

@noisysocks
Copy link
Member

#50643 @noisysocks

Decided to not make this API public for 6.3 so no dev note required yet.

@tellthemachines
Copy link
Contributor

tellthemachines commented Jun 30, 2023

Dev notes for layout-related work:

layout stabilisation
spacer block orientation
post template layout and spacing
compound layout class
reduced specificity layout rules

Edit: added layout definitions dev note.

(These could all go together in one layout-related post)

@tellthemachines
Copy link
Contributor

Ready for review

The draft post that groups all layout-related dev notes from the comment above: https://make.wordpress.org/core/?p=106122&preview=1&_ppp=f90c033a3b

@ellatrix
Copy link
Member

ellatrix commented Jul 5, 2023

Proposed Dev Note for the iframe PRs:

https://make.wordpress.org/core/?p=106178&preview=1&_ppp=c7bb7ce20d

Post Editor Iframed

From WordPress 6.3, the post editor will be iframed if all registered blocks have a Block API version 3 or higher. Adding version 3 support means that the block should work inside an iframe, though the block may still be rendered outside the iframe if not all blocks support version 3.

It is worth noting that the Site Editor and Page Template Editor have always been iframed, alongside block and pattern previews, and will continue to be iframed regardless of the Block API version.

In order to make adoption easier, all assets (styles and scripts) added through the enqueue_block_assets PHP action will now also be enqueued for the iframe. See this PR.

Please try to make your blocks compatible, and let me know if you run into any problems or have suggestions. In a future version of WordPress, the editor content will load within an iframe regardless of the Block API version.

For more information about why we are iframing the editor content, see:

https://make.wordpress.org/core/2021/06/29/blocks-in-an-iframed-template-editor/ [embed]

@aaronrobertshaw
Copy link
Contributor

Proposed dev note for the Block Selectors API:

https://make.wordpress.org/core/?p=106203&preview=1&_ppp=8dda7565b7

Unfortunately, I'll be AFK for a little over a week so might need someone to pick this up to address any feedback 🙏

@Leonardus-Nugraha
Copy link
Author

Thanks @ellatrix , @aaronrobertshaw , @noahtallen , @kevin940726 , and @tellthemachines. I've reviewed the dev notes drafts, and they're up for final checking by @bph before publishing.

I'd also remind everyone that we still need dev notes for the following PRs. Can they be delivered this Friday, if possible?
#48076 @ellatrix
#49475 @scruffian
#49655 @ellatrix
#50257 @ntsekouras
#51144 @glendaviesnz
#50139 @ntsekouras
#50385 @ntsekouras
#51020 @ndiego
#47322 @jorgefilipecosta
#50621 @andrewserong
#50510 @scruffian
#50691 @youknowriad
#51169 @youknowriad
#49134 @jsnajdr

@andrewserong
Copy link
Contributor

Thanks for the ping @Leonardus-Nugraha!

@tellthemachines added one for this PR in #50621 (comment), which can most likely be combined with the other layout dev notes.

@Leonardus-Nugraha
Copy link
Author

Oh, sorry I missed that @andrewserong, @tellthemachines already added that to the draft for all Layout dev-notes.
Thanks!

@youknowriad
Copy link
Contributor

I've prepared a draft for the command center dev note https://make.wordpress.org/core/?p=106472&preview=1&_ppp=86b7098999 but the problem is that most of this post has been copied form the request for feedback we previously published in https://make.wordpress.org/core/2023/05/17/command-center-request-for-feedback/ since the API didn't change. I think it's fine but wanted to mention just in case.

@ndiego
Copy link
Member

ndiego commented Jul 12, 2023

Sorry for the delay! I'll get #51020 done by Friday.

@Leonardus-Nugraha Leonardus-Nugraha self-assigned this Jul 13, 2023
@scruffian
Copy link
Contributor

#49475 @scruffian

This is a private API so I think we don't need a post about it.

@scruffian
Copy link
Contributor

#50510 @scruffian

Draft here: https://make.wordpress.org/core/?p=106719

@ndiego
Copy link
Member

ndiego commented Jul 16, 2023

#51020 @ndiego

Sorry for the delay on this. The draft is here: https://make.wordpress.org/core/?p=106677&preview=1&_ppp=8c7d8f9fb4

@Leonardus-Nugraha
Copy link
Author

Thanks @ntsekouras, @youknowriad, @scruffian, and @ndiego, for the dev notes!
We only have 3 PRs left to do:
#51144
#47322
#49134
@glendaviesnz, @jorgefilipecosta, @jsnajdr, will we have dev notes for these PRs?

@glendaviesnz
Copy link
Contributor

Sorry about the delay. this functionality has been a little in flux, first draft for #51144 up.

@Leonardus-Nugraha
Copy link
Author

Thanks @glendaviesnz!

@youknowriad are you planning to add video to your Command Palette API dev note? https://make.wordpress.org/core/?p=106472&preview=1&_ppp=86b7098999

@bph
Copy link
Contributor

bph commented Jul 17, 2023

@scruffian do you have an code example for the dev note https://make.wordpress.org/core/?p=106719 on the prioritizing blocks in the inserter? I think it would be more helpful.

@ndiego
Copy link
Member

ndiego commented Jul 17, 2023

Thanks for the review @Leonardus-Nugraha, the Dev Note for #51020 is now published here.

@ellatrix
Copy link
Member

What is the review process of getting the iframe note published? Here is a refreshed link: https://make.wordpress.org/core/?p=106178&preview=1&_ppp=095d4a9810

@Leonardus-Nugraha
Copy link
Author

Leonardus-Nugraha commented Jul 18, 2023

@ellatrix thanks! I've added that dev notes to the Miscellaneous Editor dev notes post, scheduled for publishing today

@scruffian
Copy link
Contributor

@scruffian do you have an code example for the dev note https://make.wordpress.org/core/?p=106719 on the prioritizing blocks in the inserter? I think it would be more helpful.

I updated the post with some pseudo code, it's hard to give a real example because of the different ways you might implement useInnerBlocksProps, which could make the example more confusing!

@jsnajdr
Copy link
Member

jsnajdr commented Jul 20, 2023

@Leonardus-Nugraha For #49134, the "dev note" would be one or two short paragraphs. I don't think it warrants its own blog post. I'd rather squeeze it as a section into some larger document ("other miscellaneous changes"), if anything like that exists.

@jorgefilipecosta
Copy link
Member

Hi @Leonardus-Nugraha,
Here is the dev note for #47322.
It is not an essential dev note it does not change behavior and is just an expansion of the API I guess it makes sense to publish it as part of other posts.

Patterns on the create a new template modal

In WordPress 6.2, we introduced a new modal for creating templates. This modal presents the option to start a new template from a "blank" state or use the current fallback of the template. In WordPress 6.3, we expanded this modal's functionality to display patterns that are suitable for a given template.

For a pattern to appear in the modal, it needs to specify a property called templateTypes, which is an array containing the templates where the patterns can be used as the full content.

Here's an example that demonstrates adding a pattern to the start of a 404 template:

register_block_pattern(
	'my-patterns/404-template',
	array(
		'title'      => __( 'New 404 pattern', 'gutenberg' ),
		'templateTypes' => array( '404' ),
		'content'    => '<!-- wp:paragraph {"align":"center","fontSize":"x-large"} -->
						<p class="has-text-align-center has-x-large-font-size">404</p>
						<!-- /wp:paragraph -->',
	)
);

@ellatrix
Copy link
Member

ellatrix commented Aug 2, 2023

For the record, I added some extra info to the iframe section: https://make.wordpress.org/core/2023/07/18/miscellaneous-editor-changes-in-wordpress-6-3/#post-editor-iframed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Tracking Issue Tactical breakdown of efforts across the codebase and/or tied to Overview issues.
Projects
Status: Done
Development

No branches or pull requests