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

Review templates - Lesson #869

Closed
Tracked by #821
jonathanbossenger opened this issue Aug 2, 2022 · 9 comments
Closed
Tracked by #821

Review templates - Lesson #869

jonathanbossenger opened this issue Aug 2, 2022 · 9 comments
Assignees

Comments

@jonathanbossenger
Copy link
Collaborator

jonathanbossenger commented Aug 2, 2022

IMPORTANT

This lesson plan belongs to part of a greater course, Extend a Low Code Block Theme which depends on the completion of Create a Custom Block Theme #1

Please reach out to @jonathanbossenger (Jonathan Bossenger) in the #training team Slack if you would like to help with this lesson plan.

Topic Description

The goal of this lesson is to review how creating templates work in a block theme, reviewing this lessons from the first course

This lesson will also cover some of the additional templates that can be created from the Site Editor, for example:

  • Creating a default page template
  • Creating a blog archive template for blog posts

Objectives

After completing this lesson, participants will be able to:

  • Review the landing page template created in the first course
  • Create additional templates, based on the available options in the Site Editor

Guidelines

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

Lesson for review:

Block Theme Templates

Review checklist

Reviewers: this is not an extensive list, but it would be helpful if you can keep the following questions in mind while reviewing.

  1. Are there any spelling/grammar issues or anything that doesn't make sense?
  2. Is the content technically correct?
  3. Does the layering of information successfully build from lesson to lesson
  4. Can you follow the steps outlined in the course
  5. Does the lesson contain enough relevant links to documentation (WordPress documentation, or any other relevant documentation)
@jonathanbossenger jonathanbossenger added [Experience Level] Intermediate Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues. labels Aug 2, 2022
@jonathanbossenger jonathanbossenger changed the title Topic - Lesson Plan [Related Course: Extend a Low Code Block Theme] Review templates - Lesson Plan Aug 2, 2022
@jonathanbossenger jonathanbossenger changed the title [Related Course: Extend a Low Code Block Theme] Review templates - Lesson Plan Review templates - Lesson Plan Aug 26, 2022
@jonathanbossenger
Copy link
Collaborator Author

Draft Lesson: https://github.com/jonathanbossenger/block-theme-course/blob/main/module-01/02-Review-Templates.md

I have not taken screenshots at this time, as I want to make sure to take screenshots following the contents of the Create a Block Theme (Low Code) course, which I will do once the first few modules of that course are ready to be reviewed.

@jonathanbossenger jonathanbossenger self-assigned this Sep 16, 2022
@jonathanbossenger jonathanbossenger removed [Content Type] Lesson Plan Awaiting Triage Issues awaiting triage. See Training Team handbook for how to triage issues. labels Sep 21, 2022
@jonathanbossenger jonathanbossenger changed the title Review templates - Lesson Plan Review templates - Lesson Sep 21, 2022
@westnz
Copy link
Collaborator

westnz commented Sep 27, 2022

Feedback - Block Theme Templates

  • You explain what block theme templates are very well and highlight the advantage of using a block theme.

  • This was a bit confusing to me:

Did you want to say, 'In the last lesson, you will create an empty index.html template file.'? Why then jump into 'Let's add some content to this template.' I would suggest providing more clarity here.
image

  • I was wondering if there is a way to add a border around screenshots in Sensei to show a clear break from the content. This is something I had in mind when I created the FSE course as well. Something to look into when the content is transferred.

  • I mentioned using colours to make the 'Do' and 'Note' sections stand out in the previous lesson, but then I realised these action steps are not in Sensei yet. Are you planning on using Call Out blocks for these?

  • Are the examples from the screenshot below supposed to have 'Do:' in front of them like the others? There are some other action steps without 'Do:' in front of them as well. This is important for uniformity/cohesion.

image

  • Should this have 'Note:' in front of it? There are some others like this as well. This is important for uniformity/cohesion.

image

  • Is the text always so close to the Template List View when you do this? Just something that caught my eye.

image

Spelling/Punctuation

  • Ensure 'Site Editor' is in capital letters throughout the course.

  • Change query loop block to Query Loop block.

  • Add a full stop after 'template'.

image

@jonathanbossenger
Copy link
Collaborator Author

jonathanbossenger commented Sep 28, 2022

Thanks for the review feedback @westnz

Did you want to say, 'In the last lesson, you will create an empty index.html template file.'?

It was supposed to be 'In the last lesson, you created an empty index.html template file.' Fixed

I was wondering if there is a way to add a border around screenshots in Sensei to show a clear break from the content.

Yes, I noticed this as well, and I plan to add a 1px border around the images. I actually had this exact same issue when I was creating content at my previous position, we had an inline CSS snippet we had to add to each and every image. 🙈

Are you planning on using Call Out blocks for these?

As discussed in the previous review comments, yes. Unfortunately, they just don't exist on GitHub.

Are the examples from the screenshot below supposed to have 'Do:' in front of them like the others?
Should this have 'Note:' in front of it?

Thanks for picking this up, I started adding the Do or Note or Tip heading to the quote blocks in markdown about halfway through this module when the idea came to me, and probably forgot to go back and ensure they were all there. Fixed

Is the text always so close to the Template List View when you do this? Just something that caught my eye.

This is probably only because I've not applied any styles via theme.json to the theme yet, so there's no layout or spacing implemented on the theme itself.

Ensure 'Site Editor' is in capital letters throughout the course.

I was confused by this one, as the developer handbook has it as Site Editor, but the support handbook does not. However, I'll make sure to stick to Site Editor going forward. Fixed (as well as the rest of the spelling/punctuation errors.

@westnz
Copy link
Collaborator

westnz commented Sep 29, 2022

Great stuff!

It was supposed to be 'In the last lesson, you created an empty index.html template file.' Fixed
Maybe you should rather say 'previous' instead of 'last'.

@annezazu
Copy link

One of the main advantages of block themes over classic themes, is that you can edit existing templates or create new theme templates from the Site Editor.

When would you do each? I'd touch on that a bit to share some best practices.

Otherwise, this looks solid to me!

@jonathanbossenger
Copy link
Collaborator Author

Thanks for the feedback @annezazu

When would you do each? I'd touch on that a bit to share some best practices.

That's a solid point, I'll add some content around when you might do each.

@wparasae
Copy link
Collaborator

wparasae commented Oct 17, 2022

  1. Quick typo!

One of the main advantages of block themes over classic themes, is that you can edit existing templates or create new theme templates from the Site Editor.

Remove comma between themes and is :)

/EDIT/ - I didn't see there was more information below a screenshot! Facepalm... reviewing properly now..

  1. Quick Revision - Consider adding this tutorial about taking advantage of query loops for user idea-generation to this sentence:

"Go ahead and add a query loop to the template, the pagination block, and a spacer to allow a bit of space between the query loop and the pagination."

Random Thoughts - I wonder if a tutorial on theme blocks might be useful to refer to as a form of remediation. I'm not sure your audience will necessary need that, but it's something to consider. :) Otherwise, this looks good so far!

@jonathanbossenger
Copy link
Collaborator Author

Thanks for the feedback @wparasae I've made the updates and suggestions.

@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
None yet
Development

No branches or pull requests

4 participants