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.

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

Add nested block / inner block to tutorial #17559

Merged
merged 6 commits into from Jan 2, 2020
Merged

Add nested block / inner block to tutorial #17559

merged 6 commits into from Jan 2, 2020

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Sep 24, 2019 •
edited

Description

Adds a new page to the block tutorial for Nested Blocks using InnerBlocks.

How has this been tested?

Follow documentation and confirm it works. View live on branch here.

Types of changes

Documentation.

@mkaz mkaz added [Type] Developer Documentation Documentation for developers [Status] In Progress Tracking issues with work in progress labels Sep 24, 2019
@mkaz mkaz removed the [Status] In Progress Tracking issues with work in progress label Oct 3, 2019
@gziolo gziolo added the [Feature] Nested / Inner Blocks Anything related to the experience of nested/inner blocks inside a larger container, like Group or P label Oct 10, 2019
oandregal
oandregal reviewed Oct 11, 2019
View reviewed changes
docs/toc.json
@@ -86,7 +86,9 @@
{ "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] },
{ "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] },
{ "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] },
{ "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }
{ "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] },
Copy link
Member

Choose a reason for hiding this comment

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

How about shifting the order and having the inner blocks tutorial first? The steps of the block tutorial look clearer that way (build more complex things as you advanced) and the rhythm doesn't get broken by the CLI tutorial (which isn't about things you could use to build blocks but block set up instead).

Copy link
Member

Choose a reason for hiding this comment

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

I'm wondering if this CLI tutorial is still up to date 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeh, I kinda want to remove the CLI suggestion. I was going to post about that in a separate PR. I'm not sure if the scaffolding that it generates is really what we want.

Copy link
Member

Choose a reason for hiding this comment

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

It may be worth revisiting the CLI part, even to delete it. In the meantime, I think that section fits better after the nested/inner blocks tutorial.

@oandregal
Copy link
Member

I've gone too tactical perhaps in that I've commented on little things here and there. My bigger question is: do we require this new addition to the block tutorial to be a full working example with the corresponding code in gutenberg-examples repo? The other parts of the tutorial do have that, so I guess we should follow that pattern. If we feel that we can do differently, I'm open to other approaches.

@mkaz @nosolosw
Apply suggestions from code review
175ab2a 
Thanks for the improvements!

Co-Authored-By: Andrés <nosolosw@users.noreply.github.com>
@mkaz
Copy link
Member Author

@nosolosw yes, I think we should add it to gutenberg-examples repo, but that should not be necessary for merge, it is better to get some documentation up than none.

The gutenberg-examples repo being numbered makes it tricky to add items to it. Since I think this one could fit in-between other lessons. I also don't like the disconnect between the explanation in the tutorial and the examples repo, but not quite sure how to solve.

So I've been mulling over how we could adopt and change that repo, but haven't really come up with something concrete enough to propose.

oandregal
oandregal approved these changes Jan 2, 2020
View reviewed changes
Copy link
Member

@oandregal oandregal left a comment

Choose a reason for hiding this comment

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

I've left a couple of comments; otherwise, this can be merged.

@oandregal oandregal mentioned this pull request Jan 2, 2020
Merged
@oandregal
Copy link
Member

I've created WordPress/gutenberg-examples#102 to port this example to gutenberg-examples.

@mkaz @nosolosw
Apply suggestions from code review
8ad8606 
Co-Authored-By: Andrés <nosolosw@users.noreply.github.com>
@mkaz mkaz merged commit 772a5d5 into master Jan 2, 2020
@mkaz mkaz deleted the docs/add-nested-block branch January 2, 2020 17:48
@youknowriad youknowriad added this to the Gutenberg 7.2 milestone Jan 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oandregal oandregal oandregal approved these changes

@gziolo gziolo gziolo left review comments

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

@youknowriad youknowriad Awaiting requested review from youknowriad

@jorgefilipecosta jorgefilipecosta Awaiting requested review from jorgefilipecosta

Assignees
No one assigned
Labels
[Feature] Nested / Inner Blocks Anything related to the experience of nested/inner blocks inside a larger container, like Group or P [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 7.2
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@mkaz @oandregal @gziolo @youknowriad