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: Re-examining introduction tutorials #27136

Closed
paaljoachim opened this issue Nov 20, 2020 · 2 comments
Closed

Documentation: Re-examining introduction tutorials #27136

paaljoachim opened this issue Nov 20, 2020 · 2 comments
Assignees
Labels
[Type] Developer Documentation Documentation for developers

Comments

@paaljoachim
Copy link
Contributor

paaljoachim commented Nov 20, 2020

---- Issue is being worked on. ----

I am re-examining the what I would call introduction tutorials.

Focused on: Contributors, theme/plugin/etc developers and someone who wants to give feedback to Gutenberg.

The doorway would be this tutorial to setup a local WP development environment:
https://developer.wordpress.org/block-editor/tutorials/devenv/#quickstart

After setting up the above there are different directions depending on what one wants to accomplish.

  1. I want to test PR's:
    Docs: How to pull a Gutenberg PR to your local WP develop environment setup. #25202
    (Issue is still being developed. I should end up with a few simple as possible testing methods.

  2. I want to contribute to Gutenberg by submitting a PR.
    With code:
    https://developer.wordpress.org/block-editor/contributors/develop/
    With documentation:
    https://developer.wordpress.org/block-editor/contributors/document/

  3. I want to create a Gutenberg block.
    https://developer.wordpress.org/block-editor/tutorials/block-tutorial/

  4. I want to create a Gutenberg pattern.
    https://developer.wordpress.org/block-editor/developers/block-api/block-patterns/

NB. I will add on to the list, but need to focus on just a few tutorials at a time.

Bottom line is a step by step approach is needed for most tutorials. I plan to re-examine the above in relation to simplifying steps where it is needed.

This issue touches very strongly on what Justin wrote about in these documentation posts:
https://make.wordpress.org/docs/2020/08/13/plan-proposal-for-a-new-better-structured-gutenberg-developer-documentation/
and
https://make.wordpress.org/docs/2020/11/12/follow-up-on-gutenberg-developer-documentation-restructuring-proposal/

@paaljoachim paaljoachim self-assigned this Nov 20, 2020
@paaljoachim paaljoachim added the [Type] Developer Documentation Documentation for developers label Nov 20, 2020
@ryanwelcher
Copy link
Contributor

@paaljoachim just wanted to follow up on this to see if it is still relevant.

@paaljoachim
Copy link
Contributor Author

paaljoachim commented Mar 30, 2023

Thanks for the nudge Ryan!

I have not followed up on this issue for a long time so I will go ahead and close it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

2 participants