WordPress / developer-blog-content

In this GitHub space, WordPress team coordinates content to be published on the Developer Blog. Discussions and montly meetings (first Thu - 13:00 UTC) in WP Slack #core-dev-blog
https://developer.wordpress.org/news
40 stars 5 forks source link

Patterns - tips and tricks for developers #235

Closed justintadlock closed 8 months ago

justintadlock commented 8 months ago

Discussed in https://github.com/WordPress/developer-blog-content/discussions/226

Originally posted by **bph** February 20, 2024 Now that patterns are a massive component of block theme development, and theme developers might want to reuse certain patterns over multiple sites/theme, it would be good to know what tips designers can give who have published a series of block themes. What to think about when you want to create site-agnostic patterns? What makes patterns most manageable ( wrap it in a top-level group block ) How best to use styles? What about colors and typography? How to handle content and media assets?
justintadlock commented 8 months ago

This topic was approved in the March Editorial Group meeting.

@beafialho - If you comment on this ticket, someone from the team can assign it to you.

beafialho commented 8 months ago

Thank you, I'm currently working on this

beafialho commented 8 months ago

👋 Here's a draft for the post.

justintadlock commented 8 months ago

This looks like a pretty good set of practices. I've finished the second review and left my suggestions in the doc.

I did have one other nit-pick about the overall tone of the draft:

The biggest issue for me when reading was that it felt impersonal. It is a very opinionated piece on recommended practices but was detached from the person. The authority here feels like the Dev Blog. But the authority should be you and your experience. I'd love to see you integrate more of yourself and your experience in the intro section. It doesn't have to be over the top. Something simple like this would work:

Here are the lessons that I've learned working with patterns while building...

Think of the post more as "My Best Practices for Patterns" rather than "The Best Practices for Patterns." I think you can really capture that with a short paragraph in the intro that lets the reader know where you're coming from.

Hope that helps. Anyway, good work!

ironnysh commented 8 months ago

That's a great article, @beafialho. I really like that you're bringing a designer's perspective to the Developer blog

bph commented 8 months ago

@beafialho I added your as an author to the WordPress Developer Blog and you should have received an invitation.

bph commented 8 months ago

When you are worked through the feedback, you are ready to publish:

Pre-publishing checklist: (updated 1/29/2024)

Post-publishing checklist

beafialho commented 8 months ago

Thanks everyone for your feedback!

The biggest issue for me when reading was that it felt impersonal. It is a very opinionated piece on recommended practices but was detached from the person. The authority here feels like the Dev Blog. But the authority should be you and your experience. I'd love to see you integrate more of yourself and your experience in the intro section. It doesn't have to be over the top.

@justintadlock great point! I have suggested a different intro paragraph in the Google Doc. If you want to take a look, I am ready of bring it to the editor.

justintadlock commented 8 months ago

@beafialho - Looks great!

beafialho commented 8 months ago

Thank you! I've created the post (preview here), and have verified all in the pre-publishing checklist.

Here is the copy for social post:

What makes a well designed pattern? And what ensures that a pattern integrates flawlessly into any WordPress site? A designer shares some of the lessons they've learned while building themes and websites.

bph commented 8 months ago

Published it! Pattern design tips and tricks for developers

abhansnuk commented 8 months ago

Well done @beafialho and hope you will write more pieces like this for the blog.

bph commented 8 months ago

@beafialho Can you please double-check on the slide show you used if it's display all the information you wanted it to display.

The editor view has some explanatory text that goes with each slide. Screenshot 2024-03-19 at 17 37 01

The text does not display on the frontend. Screenshot 2024-03-19 at 17 36 19

Do we need to see for a different way to relay the information? Or check in with @ryelle or @renintw if there is a bug in the theme?

beafialho commented 8 months ago

Can you please double-check on the slide show you used if it's display all the information you wanted it to display.

I confirm, it's visible on the editor but not on the front end.

bph commented 8 months ago

Pattern design tips and tricks for developers