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

Docs: Add a tutorial on how to create a block-based theme #23732

Merged
merged 36 commits into from
Jul 15, 2020
Merged

Docs: Add a tutorial on how to create a block-based theme #23732

merged 36 commits into from
Jul 15, 2020

Conversation

carolinan
Copy link
Contributor

@carolinan carolinan commented Jul 7, 2020 •
edited
Loading

Description

Adds a tutorial on how to create a block-based theme.
Closes #23698

-Image links will need to be updated.

carolinan added 30 commits May 23, 2020 09:24
@carolinan
Merge pull request #1 from WordPress/master
7880b05 
sync
@carolinan
Merge pull request #3 from WordPress/master
2e83755 
sync
@carolinan
Merge pull request #5 from WordPress/master
117b302 
sync
@carolinan
Merge pull request #6 from WordPress/master
af4fcd9 
sync with master
@carolinan
Merge pull request #8 from WordPress/master
02d507f 
sync with master
@carolinan
Add block based themes to the tutorial section
2738a0d
@carolinan
Update README.md
d09dff9
@carolinan
Update README.md
58d5aef
@carolinan
Update README.md
c1ddd1c
@carolinan
Update README.md
32a9907
@carolinan
Create adding-blocks.md
73e63f5
@carolinan
Update README.md
bd080bf
@carolinan
Update adding-blocks.md
499e53b
@carolinan
Update adding-blocks.md
ca02cbd
@carolinan
Update adding-blocks.md
4de2c7b
@carolinan
Update adding-blocks.md
2fb52a3
@carolinan
Update adding-blocks.md
c2285e8
@carolinan
Update README.md
8ce4f8d
@carolinan
Update README.md
fb616b0
@carolinan
Update adding-blocks.md
1af6b7e
@carolinan
Update README.md
32ede0e
@carolinan
Add files via upload
b2b42e9
@carolinan
Add files via upload
04799b9
@carolinan
Add files via upload
f3030f5
@carolinan
Add files via upload
2c29f8a
@carolinan
Update adding-blocks.md
43d04ff
@carolinan
Update adding-blocks.md
51f2e9c
@carolinan
Update adding-blocks.md
e7432c2
@carolinan
Update adding-blocks.md
1b09219
@carolinan
Update adding-blocks.md
2569574
gziolo
gziolo reviewed Jul 7, 2020
View reviewed changes
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Thank you for starting this PR 👍

Can we host all images on wordpress.org? Git isn’t the best place to store media because it quickly increases the size of repository for all contributors. It keeps all copies that were ever included in its history.

@gziolo gziolo requested review from epiqueras, oandregal and ItsJonQ July 7, 2020 05:24
@carolinan
Copy link
Contributor Author

I am not sure how :) Do we open a meta ticket once the content has been reviewed?

@carolinan
Update README.md
7966225 
Fixed a typo.
@kjellr kjellr self-requested a review July 7, 2020 11:40
@gziolo
Copy link
Member

gziolo commented Jul 7, 2020

I am not sure how :) Do we open a meta ticket once the content has been reviewed?

Good question. I never did that, but I believe @mapk should know how the process looks like.

kjellr
kjellr reviewed Jul 7, 2020
View reviewed changes
Copy link
Contributor

@kjellr kjellr left a comment

Choose a reason for hiding this comment

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

This is looking great! Thanks for writing this out, @carolinan! I've uploaded the images to wordpress.org/gutenberg/, which is where we've hosted other documentation images in the past:

https://wordpress.org/gutenberg/files/2020/07/block-based-themes-template-menu.png
https://wordpress.org/gutenberg/files/2020/07/block-based-themes-save.png
https://wordpress.org/gutenberg/files/2020/07/block-based-themes-page-menu.png
https://wordpress.org/gutenberg/files/2020/07/block-based-themes-page-menu.png
https://wordpress.org/gutenberg/files/2020/07/block-based-themes-editor-template-part.png
https://wordpress.org/gutenberg/files/2020/07/block-based-themes-appearance-template-parts.png

So feel free to swap those out.

You'll need to also run the documentation scripts since this adds new pages — I can't find the documentation for those (oddly enough 😂), but maybe someone else can point you in the right direction.

docs/designers-developers/developers/tutorials/block-based-themes/README.md Outdated Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/README.md Outdated Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/README.md Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/README.md Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/adding-blocks.md Outdated Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/README.md Show resolved Hide resolved
@gziolo
Copy link
Member

gziolo commented Jul 7, 2020

You'll need to also run the documentation scripts since this adds new pages — I can't find the documentation for those (oddly enough 😂), but maybe someone else can point you in the right direction.

It's here:
https://github.com/WordPress/gutenberg/blob/master/docs/contributors/document.md#create-a-new-document

@kjellr kjellr mentioned this pull request Jul 7, 2020
Merged
carolinan and others added 3 commits July 7, 2020 17:38
@carolinan @kjellr
Apply suggestions from code review
df3f744 
Co-authored-by: Kjell Reigstad <kjell@kjellr.com>
@carolinan
Merge pull request #15 from WordPress/master
b599553 
keeping branch up to date
@carolinan
Deleted images and replaced the image links.
3d7cccd 
Deleted images and replaced the image links.
Fixed typos.
Renamed the adding-blocks file to include the tutorial topic.
Updated toc.json and ran docs:build.
@carolinan
Copy link
Contributor Author

Got feedback that it is confusing how to add the post loop

@kjellr
Copy link
Contributor

kjellr commented Jul 13, 2020

Got feedback that it is confusing how to add the post loop

Maybe a screenshot would help there?

mkaz
mkaz requested changes Jul 13, 2020
View reviewed changes
Copy link
Member

@mkaz mkaz 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, a link fix and a minor punctuation tweak.

docs/designers-developers/developers/tutorials/block-based-themes/README.md Outdated Show resolved Hide resolved
docs/designers-developers/developers/tutorials/block-based-themes/README.md Outdated Show resolved Hide resolved
carolinan and others added 2 commits July 14, 2020 11:12
@carolinan @mkaz
Update docs/designers-developers/developers/tutorials/block-based-the…
0dddddd 
…mes/README.md

Co-authored-by: Marcus Kazmierczak <marcus@mkaz.com>
@carolinan @mkaz
Update docs/designers-developers/developers/tutorials/block-based-the…
b5ec303 
…mes/README.md

Co-authored-by: Marcus Kazmierczak <marcus@mkaz.com>
@kjellr
Copy link
Contributor

kjellr commented Jul 15, 2020

This is looking great, thank you @carolinan! I'll merge this and we can continue iterating in new PRs as needed. 🙌

@kjellr kjellr merged commit 7aacd09 into WordPress:master Jul 15, 2020
@github-actions github-actions bot added this to the Gutenberg 8.6 milestone Jul 15, 2020
@kjellr kjellr added the [Feature] Themes Questions or issues with incorporating or styling blocks in a theme. label Jul 15, 2020
@kjellr kjellr mentioned this pull request Jul 20, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gziolo gziolo gziolo left review comments

@kjellr kjellr kjellr left review comments

@mkaz mkaz mkaz approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

@epiqueras epiqueras Awaiting requested review from epiqueras

@oandregal oandregal Awaiting requested review from oandregal

@ItsJonQ ItsJonQ Awaiting requested review from ItsJonQ

Assignees
No one assigned
Labels
[Feature] Themes Questions or issues with incorporating or styling blocks in a theme. [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 8.6
Development

Successfully merging this pull request may close these issues.

Documentation: Add a tutorial on how to create a block-based theme
4 participants
@carolinan @gziolo @kjellr @mkaz