Skip to content

Handbook: Clarify the type of apiVersion in block metadata #33249

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.

Sign up for GitHub

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

Jump to bottom
Merged
gziolo merged 1 commit into from
Jul 7, 2021
Merged

Handbook: Clarify the type of apiVersion in block metadata #33249

gziolo merged 1 commit into from
Jul 7, 2021

Conversation

@gziolo
Copy link
Member

@gziolo gziolo commented Jul 7, 2021 •
edited
Loading

Description

It looks like there is some misunderstanding about what type apiVersion should have in the block.json file. It was raised by @richtabor on WordPress Slack https://wordpress.slack.com/archives/C02QB2JS7/p1625616501376100:

Question. I’m checking a block (Markdown Comment) with the Block Plugin Checker and I’m seeing this block.json file error. I’m using the same method as indicated in core, as well as the recent Block API Enhancements post. Is this an invalid error, or am I missing something? Thanks!

image

This PR adds the missing section covering apiVersion in block metadata reference guide.

The changes in the Block Plugin Checker are discussed in https://meta.trac.wordpress.org/ticket/5303.

Types of changes

Documentation update.

@gziolo gziolo added [Feature] Block API API that allows to express the block paradigm. [Type] Developer Documentation Documentation for developers labels Jul 7, 2021
@gziolo gziolo self-assigned this Jul 7, 2021
@gziolo gziolo requested review from ellatrix and richtabor July 7, 2021 08:18
Mamaduka
Mamaduka approved these changes Jul 7, 2021
View reviewed changes
Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

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

LGTM :shipit:

@gziolo gziolo merged commit 8499a38 into trunk Jul 7, 2021
@gziolo gziolo deleted the update/docs-api-version-block-metadata branch July 7, 2021 08:49
@github-actions github-actions bot added this to the Gutenberg 11.1 milestone Jul 7, 2021
sarayourfriend pushed a commit that referenced this pull request Jul 15, 2021
@gziolo @sarayourfriend
Handbook: Clarify the type of apiVersion in block metadata (#33249)
f631537
@priethor priethor mentioned this pull request Jul 19, 2021
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mamaduka Mamaduka Mamaduka approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

@richtabor richtabor Awaiting requested review from richtabor

@ellatrix ellatrix Awaiting requested review from ellatrix

Assignees

@gziolo gziolo

Labels

[Feature] Block API API that allows to express the block paradigm. [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 11.1

Development

Successfully merging this pull request may close these issues.

3 participants

@gziolo @Mamaduka