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

Documentation: Add the transforms page to the create block tutorial of the platform docs #56559

Merged
merged 4 commits into from
Nov 28, 2023

Conversation

youknowriad
Copy link
Contributor

Related #53874

What?

This is the forth page of the "create block type" tutorial on the "Gutenberg as framework" documentation website. It adds block transformations. I think we need to move the "reference" pages to the platform docs instead of the current handbook to be able to link to the "references" from both places, but that's for later.

For instance, I think we need a reference page for the transforms, the block supports...

You can check the current state of the website locally by doing:

cd platform-docs
npm install
npm start

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Nov 27, 2023
@youknowriad youknowriad requested a review from a team November 27, 2023 14:05
@youknowriad youknowriad self-assigned this Nov 27, 2023
@youknowriad youknowriad requested review from ellatrix and tellthemachines and removed request for a team November 27, 2023 14:05
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

I left some comments but it looks good to me.

One thing I noticed is that the custom block names in the "Create a block type" section are a mix of create-block/gutenpride and gutenpride/gutenpride-block. Perhaps we should unify to gutenpride/gutenpride-block?

Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

Looks good to me too, so giving it a ✅

platform-docs/docs/create-block/transforms.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/transforms.md Outdated Show resolved Hide resolved
youknowriad and others added 2 commits November 28, 2023 10:33
Co-authored-by: Héctor <27339341+priethor@users.noreply.github.com>
@youknowriad
Copy link
Contributor Author

One thing I noticed is that the custom block names in the "Create a block type" section are a mix of create-block/gutenpride and gutenpride/gutenpride-block. Perhaps we should unify to gutenpride/gutenpride-block?

Good remark, I fixed it.

@youknowriad youknowriad enabled auto-merge (squash) November 28, 2023 09:37
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
@t-hamano t-hamano self-requested a review November 28, 2023 12:29
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link

Flaky tests detected in 4471c35.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7018655521
📝 Reported issues:

@youknowriad youknowriad merged commit d1e5080 into trunk Nov 28, 2023
52 checks passed
@youknowriad youknowriad deleted the docs/platform-docs-transforms branch November 28, 2023 12:50
@github-actions github-actions bot added this to the Gutenberg 17.2 milestone Nov 28, 2023
@bph bph added the Framework Issues related to broader framework topics, especially as it relates to javascript label Nov 29, 2023
derekblank pushed a commit that referenced this pull request Dec 7, 2023
…f the platform docs (#56559)

Co-authored-by: Héctor <27339341+priethor@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues related to broader framework topics, especially as it relates to javascript [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants