WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.51k stars 4.2k forks source link

6.2 Dev Note Tracking Issue #47771

Closed bph closed 1 year ago

bph commented 1 year ago

Tracking all Dev Notes from Gutenberg plugin releases 14.2 - 15.1

Please read the information below carefully. If you have questions, connect with @bph or @zzap 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 decision 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 receive privileges on the Make Core Blog. (Please connect with @bph or @zzap, if you need access) 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 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 dev note, please assign the label needs dev note If you already added the Dev Note to the make blog on draft or as comment on the PR, please label it has dev note


~- #46212 @ellatrix ~ not in core for 6.2

Navigation

CustomCSS

InspectorControls + Split Block Tools

Experimental APIs

WP_HTML_Tag_Processor

Blocks

Theme.json /Appearance Tools

Components @ciampo @mirka

Global Styles

Layout/ Templates

Deprecations/Removals

Create Block scaffolding

Pattern and Pattern Directory

ServerSideRender package

ciampo commented 1 year ago

Just flagging that @noisysocks is on parental leave as of today, I guess that the dev note for #45960 could be written by @ramonjd or @andrewserong who also helped on that PR?

bph commented 1 year ago

Appreciate the flag @ciampo - I updated the ping for the PR #45960 :-)

gziolo commented 1 year ago

https://github.com/WordPress/gutenberg/pull/44185 @gziolo

That were code changes that propagated what was included in the dev note for WordPress 6.1.

t-hamano commented 1 year ago

For some blocks with caption, a toolbar button has been added to add / remove caption. Should a Dev note be written about these UI changes as well?

ntsekouras commented 1 year ago

For some blocks with caption, a toolbar button has been added to add / remove caption. Should a Dev note be written about these UI changes as well?

I don't think a dev note is needed for these, as they are UI changes.

bph commented 1 year ago

Totally agree, @t-hamano + @ntsekouras - Keep the questions coming, though.

oandregal commented 1 year ago

@bph I've added @pbking and @mikachan for #43337 as they were the ones who implemented that feature :)


In the case of https://github.com/WordPress/gutenberg/issues/45171 there's only 1 thing worth having a devnote about (I presume the performance improvements do not require a devnote?). Here's the suggested text:

wp_theme_has_theme_json

WordPress 6.2 introduces a new method called wp_theme_has_theme_json(), that returns whether the active theme or its parent has a theme.json file. The goal is to provide 3rd parties with a public API they can use to query the active theme for this information.

Being so small a note, I presume it can be published as part of a bigger one?

bph commented 1 year ago

@oandregal thanks for the flag, if you want to combine PRs dev notes that is a great way to serve all the details in one post. This might go well with #45089 and others round theme.json and providing extenders with ways to interact with the settings.

oandregal commented 1 year ago

if you want to combine PRs dev notes that is a great way to serve all the details in one post.

I don't plan to, as that's my only and single contribution, and it's quite small :) I'll let others chime in. If there's no better place, it could go as part of the "miscellaneous changes" note (example in 5.9)?

t-hamano commented 1 year ago

I added a "ServerSideRender Package" section and wrote a dev note to #44491.

draganescu commented 1 year ago

I am not sure that #44739 needs a dev note, it was more like an oversight ... @Mamaduka what do you think?

Mamaduka commented 1 year ago

@draganescu probably not. It's a new feature for users.

getdave commented 1 year ago

https://github.com/WordPress/gutenberg/pull/46885 @getdave

This was a selector originally added in https://github.com/WordPress/gutenberg/pull/46531 and then subsequently modified in https://github.com/WordPress/gutenberg/pull/46885. We then decided due to its instability to make it private which I did in https://github.com/WordPress/gutenberg/pull/47638.

As a result we don't need a dev note as it's a private API.

getdave commented 1 year ago

Fully remove Navigation Editor screen and associated edit-navigation package https://github.com/WordPress/gutenberg/pull/47055 @getdave

Please see dev note here.

andrewserong commented 1 year ago

I guess that the dev note for https://github.com/WordPress/gutenberg/pull/45960 could be written by @ramonjd or @andrewserong who also helped on that PR?

Thanks for the ping @ciampo! I've added a draft dev note to the PR for the Style Book here: https://github.com/WordPress/gutenberg/pull/45960#issuecomment-1425002512

Update: draft dev note blog post is here: https://make.wordpress.org/core/?p=102735&preview=1&_ppp=03ed6e05f5

andrewserong commented 1 year ago

Since Ramon isn't around, I've added a draft dev note to cover these two over in this comment: https://github.com/WordPress/gutenberg/pull/42489#issuecomment-1425032620

aaronrobertshaw commented 1 year ago

InspectorControls + Split Block Tools

I added a draft dev note in https://github.com/WordPress/gutenberg/pull/47045#issuecomment-1425428525 that aims to cover all the closely related PRs under the "InspectorControls + Split Block Tools" section in this issue's description.

adamziel commented 1 year ago

I marked https://github.com/WordPress/gutenberg/pull/43386 as done – it doesn't require a dev note as it's a special case of an API specifically designed not to be used by contributors. I may write a separate post about it, but not a dev note.

andrewserong commented 1 year ago

I've drafted a dev note in this comment (https://github.com/WordPress/gutenberg/pull/45300#issuecomment-1429145904) to cover these PRs under the umbrella of introducing the minHeight dimensions block support

I've drafted a dev note for the sticky position block support in this comment: (https://github.com/WordPress/gutenberg/pull/46142#issuecomment-1429110220) — I've added a couple of "why" headings there to provide answers to some of the feedback raised so far.

tellthemachines commented 1 year ago

Dev note for children of flex layout blocks here!

andrewserong commented 1 year ago

Added a small draft dev note to be included in a Misc dev note in this comment: https://github.com/WordPress/gutenberg/pull/46388#issuecomment-1436142259

carolinan commented 1 year ago

I have removed [ ] #43337 @pbking @mikachan from the list because the feature is not in 6.2.

carolinan commented 1 year ago

Short dev note for per-block custom CSS https://github.com/WordPress/gutenberg/pull/46571#issuecomment-1434571591

ciampo commented 1 year ago

I made a few changes to the list of components-related PRs:

I then went ahead and added dev notes for all of the PRs in the updated list.

adamziel commented 1 year ago

I've drafted a dev note for #42122 and #46138 in a comment at [Heading block] Add a wp-block-heading CSS class

I also drafted a dev note for https://github.com/WordPress/gutenberg/pull/45089 in a comment there.

bph commented 1 year ago

Thank you so much @adamziel I added the Heading block dev note to the Misc Editor post And @ndiego drafted the dev note for #45089 on the make blog. (Thank you, Nick)

youknowriad commented 1 year ago

@bph I've drafted a dev note for the removed APIs here https://github.com/WordPress/gutenberg/pull/46106#issuecomment-1447800134 We might want to include this in a "miscellaneous editor changes" dev note.

bph commented 1 year ago

@ciampo Thank you so much for re-organizing the Component section of the DevNote tracking issue and writing the small snippets Dev note for each listed PR.
I put them all into a stand alone post in the Make Core Blog with your name on it. Would you please review it, just to double-check, I didn't have the copy/paste devil on my shoulder. Please edit as you see fit.

The two deprecation items, useAnchorRef and DateTimePicker, I added the deprecation section of the Misc Editor post

bph commented 1 year ago

Dev Notes published for WordPress 6.2

Miscellaneous Editor changes in WordPress 6.2

Huge Thank you to all who contributed to dev notes and helped to review them

If you find anything missing, please let me know so we can correct that oversight quickly, preferable before the release of 6.2 final release.

draganescu commented 1 year ago

In #48204 a change was introduced to the behavior of removing blocks. Previously, when a block was removed, the previous block was selected. However sometimes that resulted in focus loss, if there was no previous block to select.

The update is that if there is no previous block to select, the remove block behavior is updated to select the first parent instead. This should be of little impact, but if an extender relies on always getting the previous block as selection they should update their code to account for the option that sometimes the parent is selected on block removal or opt out of this new default behavior.

For example the list block had to be updated for this reason in #48204, and it opts out of parent block selection by passing false as the second argument when calling removeBlock.

bph commented 1 year ago

Thank you @draganescu Do you have time to write that in a Dev Note so it can be added to the Misc Editor note?

draganescu commented 1 year ago

@bph that is the devnote :)

bph commented 1 year ago

@draganescu You write: "they should update their code to account for the option that sometimes the parent is selected on block removal or opt out of this new default behavior."

How do extenders opt-out of this new default behavior? I know you link to some other source code, but that's now what dev notes are doing. If you point to code, you can also create a code example, and the reader isn't taking to another page for this tiny information.

Is the shouldSelectParent = false; attributes documented anywhere yet?

bph commented 1 year ago

@draganescu Please review the dev note. Feel free to augment it.

bph commented 1 year ago

The Field Guide for WordPress 6.2 was published March 9th at 5am UTC