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

Docs: Add Block Directory to Create a Block tutorial #23484

Closed
mkaz opened this issue Jun 25, 2020 · 2 comments · Fixed by #23654
Closed

Docs: Add Block Directory to Create a Block tutorial #23484

mkaz opened this issue Jun 25, 2020 · 2 comments · Fixed by #23654
Assignees
Labels
[Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers

Comments

@mkaz
Copy link
Member

mkaz commented Jun 25, 2020

The final page in the Create a Block tutorial is for the finishing touches after creating your block. This is intended to be a spot to include the details for submitting the block to the block directory. PR #22831 is now merged so we can further iterate, note the tutorial is not yet linked to the Block Editor handbook.

Next: We should get the block directory steps added to the finishing page here and the documentation work @StevenDufresne has done for auditing a block included throughout the tutorial

We also need to make sure @coreymckrill and @gziolo work for block.json in PR #23399 is included in the tutorial

cc: @annezazu
Related: #22151

@paaljoachim
Copy link
Contributor

Going through the Create a Blocking Finishing Touches page.

The page contains a very useful collection of links!

Here are my typo/rephrasing suggestions.

"This tutorial covers the basic structure of building a block, and the general concepts for creating a basic blocks. This sets you up for creating numerous more complicated blocks iterating and adding to this."
-->
This tutorial covers general concepts and structure for creating basic blocks.
(No need for this sentence: This sets you up for creating numerous more complicated blocks iterating and adding to this." )

--

"The InspectorPanel, the settings on the right for a block, and Block Controls have a standard way to implement."
-->
The InspectorPanel (the settings in the sidebar to the right for a block), and the Block Controls (toolbar controls) have a standard way to be implemented.

--

"creat" -> create
NB. The Sidebar tutorial link goes to here: https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/tutorials/plugin-sidebar-0.md
to a 404 error page.

--

"..see the Using InnerBlocks documentation" -> Add . after documentation.

--

"...and the code is available to browse."
-->
and you can browse the code. / person can view the code by doing so and so.....

--

"A good way is to find a core block doing something close to what you are interested, and read through its code to see how things are done."
-->
A good way to learn how things are done is to find a core block code that does something close to what you are interested in and then using the same approach for your own block.

@mkaz
Copy link
Member Author

mkaz commented Jul 2, 2020

@paaljoachim Thanks for the feedback, I've created the PR #23654 and included these updates 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants