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

Streamline your Block Theme development with Create Block Theme - Tutorial #1061

Closed
17 of 19 tasks
jonathanbossenger opened this issue Oct 28, 2022 · 13 comments
Closed
17 of 19 tasks
Assignees
Milestone

Comments

@jonathanbossenger
Copy link
Collaborator

jonathanbossenger commented Oct 28, 2022

Topic Description

An introduction to the theme development tools available in the create block theme plugin

  • create a blank theme
  • overwrite the active theme
  • clone the active theme
  • create a child theme
  • export the current theme

Related Resources

Links to related content on Learn, HelpHub, DevHub, GitHub Gutenberg Issues, DevNotes, etc.

  • (Create Block Theme)[https://wordpress.org/plugins/create-block-theme/]

Guidelines

Review the [team guidelines] (https://make.wordpress.org/training/handbook/guidelines/)

Tutorial Development Checklist

@jonathanbossenger jonathanbossenger added [Content Type] Tutorial Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues. labels Oct 28, 2022
@jonathanbossenger jonathanbossenger self-assigned this Oct 28, 2022
@jonathanbossenger jonathanbossenger added [Audience] Developers and removed Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues. labels Oct 28, 2022
@jonathanbossenger jonathanbossenger added this to the 6.1 milestone Oct 28, 2022
@jonathanbossenger
Copy link
Collaborator Author

streamline-create-block-theme.mp4

@abhansnuk
Copy link
Collaborator

Another enjoyable video @jonathanbossenger . A couple of comments in review, some of which are more general for us to think about for videos in general.

  • On the first slide, can we avoid the overlap with the php image and the text, and in the final sentence put some space between learn and the WordPress logo to make it easier to read.

  • Really like the welcome at the beginning. Generally for videos, could we look at having these on other videos @afshanadiya with 'Welcome to Learn.WordPress.org' to reinforce the web address and where people can go to for this information?

  • About 1.07 where a separate tutorial is referenced, are we cross-linking to this on the page, and adding a link / signpost to it (if it exists already) at the end of this video/ in general to videos?

  • A general note for the future, as I am unsure if you can amend these screens now. Towards the end of this sequence 3.44-4.17 the screens are changing very fast for readme, parts, header. The way they do may cause some visual disturbance for some users or mean they do not follow what is trying to be shown.

  • Where you are going from one area of a site to the code editor or a different part of the CMS, it can be helpful to tell the viewer what they should be looking at next if they are following along. Eg about 6.12 when you go back to the code editor.

  • For this video and more of a general question @azhiya, are we going to use examples of colors for text and background that are not accessible? The color contrast in the dark theme example at 5.22 and 8.01-8.04, 8.53, 9.43 is very low and makes the text very hard to read.

@jonathanbossenger
Copy link
Collaborator Author

@abhansnuk thanks for the review.

For this video and more of a general question @azhiya, are we going to use examples of colors for text and background that are not accessible? The color contrast in the dark theme example at 5.22 and 8.01-8.04, 8.53, 9.43 is very low and makes the text very hard to read.

I feel I should point out that I specifically used the colors from the dark theme in the Material Design spec, so as to be accessible in my demos.

@abhansnuk
Copy link
Collaborator

abhansnuk commented Nov 2, 2022

Thanks @jonathanbossenger that is useful to know. These colors are displaying without much contrast on the video in all the views I used. I have looked on multiple devices with different color contrasts, including Windows' accessible settings for color contrast, which only enhanced it very slightly. I did not view it on a large specialist graphic design, calibrated screen. This can happen sometimes on video representation of screens.

It is useful to know that you used this to be accessible. I attach an image of the dark option from the video in case it helps.

In general terms, choosing accessible colors in demos may be a point we need to help others preparing video (if it is not in the tips / checklist)
image

@westnz
Copy link
Collaborator

westnz commented Nov 2, 2022

Well done @jonathanbossenger

This is such a cool plugin!

  • Sarah told me about this website: https://capitalizemytitle.com/. I think the title of the tutorial could be in capital letters: Streamline Your Block Theme Development With Create Block Theme
  • Easy-to-follow tutorial!
  • Great pace and audio quality
  • You explain things very clearly.
  • I also found the black/purple/green a bit hard to read. Here is an idea. As you know Twenty Twenty-Three theme has 10 different styles that are tagged as Accessibility Ready. Maybe we could use one of those colour combinations in future if we are looking for an example.

@jonathanbossenger
Copy link
Collaborator Author

@abhansnuk I wonder if I could ask you to review the set of colors (and screenshot) I've suggested on this post, and let me know if that works better in terms of contrast?

@jonathanbossenger
Copy link
Collaborator Author

Leaving some general review feedback here from earlier comments/feedback.

On the first slide, can we avoid the overlap with the php image and the text, and in the final sentence put some space between learn and the WordPress logo to make it easier to read.

It's a bit hard to change this now, but I've made a note to fix this in the future.

About 1.07 where a separate tutorial is referenced, are we cross-linking to this on the page, and adding a link / signpost to it (if it exists already) at the end of this video/ in general to videos?

Unfortunately, we don't have the option to cross-link inside videos, but I do include links to any other tutorials mentioned in the text portion of the tutorial content on Learn WordPress.

A general note for the future, as I am unsure if you can amend these screens now. Towards the end of this sequence 3.44-4.17 the screens are changing very fast for readme, parts, header. The way they do may cause some visual disturbance for some users or mean they do not follow what is trying to be shown.

This was partly intentional, as I'm trying to keep the video to less than 10 minutes and focus on the topic at hand, namely the Create Block Theme plugin.

Where you are going from one area of a site to the code editor or a different part of the CMS, it can be helpful to tell the viewer what they should be looking at next if they are following along. Eg about 6.12 when you go back to the code editor.

I will make a note of this for future tutorial videos.

@jonathanbossenger
Copy link
Collaborator Author

Sarah told me about this website: https://capitalizemytitle.com/. I think the title of the tutorial could be in capital letters: Streamline Your Block Theme Development With Create Block Theme

Good point, I'll make sure to update my titles in future.

I also found the black/purple/green a bit hard to read. Here is an idea. As you know Twenty Twenty-Three theme has 10 different styles that are tagged as Accessibility Ready. Maybe we could use one of those colour combinations in future if we are looking for an example.

Thanks, I've tried a new color scheme (details here) which I'm going to use to update this video. What I was trying to do is stay away from already existing block theme styles.

@jonathanbossenger
Copy link
Collaborator Author

streamline-create-block-theme-v2.mp4

Updated with new dark theme colours.

@pbking
Copy link

pbking commented Nov 16, 2022

I have reviewed this for technical accuracy and give it a 👍 . The pacing is great and I appreciate that you kept this to (nearly) under 10 minutes.

@abhansnuk
Copy link
Collaborator

Just coming back on titles. My understanding from core, docs and marketing, and previously from training too, that the style for headlines is sentence case not title case. This is also better for accessibility.

@jonathanbossenger
Copy link
Collaborator Author

Just coming back on titles. My understanding from core, docs and marketing, and previously from training too, that the style for headlines is sentence case not title case. This is also better for accessibility.

Noted. @westnz we might want to confirm this with the training team, and if required, have the guidelines on tutorial creation updated.

@jonathanbossenger
Copy link
Collaborator Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📜 Published or Closed
Development

No branches or pull requests

4 participants