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

Fundamentals block development - landing and first pages #56584

Merged
merged 11 commits into from
Nov 28, 2023

Conversation

juanmaguitar
Copy link
Contributor

@juanmaguitar juanmaguitar commented Nov 28, 2023

This section provides an introduction to the most important concepts in Block Development.
This PR is related to the issue #56282 and it publishes a first landing page with some initial content (#56553, #56551 and #56334) that will be incremented with the new content planned for this sections as it gets published.

This PR also removes the whole How to use JavaScript with the Block Editor as the most important ideas on this topic are covered at #56553

After the merge of this PR the following redirections should be implemented:

Regarding Block Registration

Regarding Javascript

@juanmaguitar juanmaguitar added [Type] Developer Documentation Documentation for developers Developer Experience Ideas about improving block and theme developer experience labels Nov 28, 2023
@ndiego
Copy link
Member

ndiego commented Nov 28, 2023

I think we should break this into two PRs, one for the new Landing page and another to remove the JavaScript section. We will need to create redirects for all the JavaScript pages, so we probably should only remove that once the new redirects are in place.

In this section you will learn:

1. [**File structure of a block**](https://developer.wordpress.org/block-editor/getting-started/fundamentals-block-development/file-structure-of-a-block) - The purpose of each one of the types of files available for a block, the relationships between them and their role in the output of the block
<!--
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure we should include commented-out sections.

9. [**Styling blocks**](#) - The different methods available to define the styles of a block.
10. [**Lifecycle of the block**](#) - The different cycles a block is involved in (load, save, update, render) and the different formats representing the block in these cycles.
-->
1. [**Javascript in the Block Editor**](https://developer.wordpress.org/block-editor/getting-started/fundamentals-block-development/javascript-in-the-block-editor) - How to work with Javascript for the Block editor.
Copy link
Member

Choose a reason for hiding this comment

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

Minor, but some lines end in a period and some don't.

Copy link

Flaky tests detected in ef74756.
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/7018924734
📝 Reported issues:

@ndiego
Copy link
Member

ndiego commented Nov 28, 2023

I also just noticed this, but should the URL be /fundamentals-of-block-development instead of /fundamentals-block-development?

@juanmaguitar
Copy link
Contributor Author

@ndiego Thanks for the feedback!
I have addressed it and updated the PR

@juanmaguitar
Copy link
Contributor Author

I also just noticed this, but should the URL be /fundamentals-of-block-development instead of /fundamentals-block-development?

Would there be any specific benefit changing to /fundamentals-of-block-development the current URL (/fundamentals-block-development)

@juanmaguitar juanmaguitar requested a review from ndiego November 28, 2023 13:17
@ndiego
Copy link
Member

ndiego commented Nov 28, 2023

Would there be any specific benefit changing to /fundamentals-of-block-development the current URL (/fundamentals-block-development)

It just more accurately reflects the title of the page, but it makes the URL even longer. I wonder if just /fundamentals would work. It would be an easier URL to type/remember? I don't have a strong opinion either way.

@juanmaguitar
Copy link
Contributor Author

It just more accurately reflects the title of the page, but it makes the URL even longer. I wonder if just /fundamentals would work. It would be an easier URL to type/remember? I don't have a strong opinion either way.

@ndiego I have changed the folder to fundamentals and the references to it

Copy link
Member

@ndiego ndiego 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!

@juanmaguitar juanmaguitar merged commit 4494a79 into trunk Nov 28, 2023
49 checks passed
@juanmaguitar juanmaguitar deleted the fundamentals-block-development-root branch November 28, 2023 17:56
@github-actions github-actions bot added this to the Gutenberg 17.2 milestone Nov 28, 2023
derekblank pushed a commit that referenced this pull request Dec 7, 2023
* Add fundamentals of block development
documentation

* Remove JavaScript how-to guides and update block development fundamentals landing

* Update block development fundamentals documentation

* Manifest and TOC

* Update block development documentation links

* Update block development documentation links

* restored how-to-guides javascript

* Update TOC

* update folder name of fundamentals section
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants