10up/gutenberg-best-practices

Feedback after completing training course - Feb 18

gthayer opened this issue · 2 comments

I just completed the Training Course. I've created a PR for any spelling an grammar issues I saw, but below are my open questions:

https://gutenberg.10up.com/training

  • "We also welcome bug reports, suggestions and contributions via the"
    • Is this the correct URL? 10up/gutenberg-best-practices has similar content.

https://gutenberg.10up.com/training/cta-lesson

  • We need to be sure description is included in the attributes object below:
    • This example does not match the structure within the edit.js file.
    • Example should also not inlcude ctaText, ctaLink and showCTALink at this stage.
  • Set the props for the component to update the attribute that controls if the the CTA is enabled ( Refer to cta-complete/block,json if you get stuck )
    • Should this be cta-complete/edit.js?

https://gutenberg.10up.com/training/styles

  • Create an image.js file in /includes/block-styles/
    • The file already exits.

https://gutenberg.10up.com/training/variations

  • When added registerBlockVariation, I think it would be helpful to describe what the attributes here do. Ex: "scope" is not immediately clear.
  • Are block variations different than block patterns? If yes, I think a brief explanation of the difference and when you'd use one or the other would be helpful.

https://gutenberg.10up.com/training/inner-blocks

  • 2. "Card Grid" Block
    • I feel like this whole section should be revisited. I think I get a lot of the point, but the semantics of the "card grid" vs "card block" is easy to overlook
    • Maybe this should be framed as an "outer card grid" and "inner card section".
  • This is similar to how core has the Buttons block that contains individual Button blocks.
    • I know this is true, but I think it distracts from the point here.
    • Maybe at the end include: "Examples of core blocks which follow this pattern are:..."
  • You are not able to insert any blocks you want and the content actually gets saved into the database and shows on the frontend.
    • Should this be You are NOW able...

https://gutenberg.10up.com/training

"We also welcome bug reports, suggestions and contributions via the"
Is this the correct URL? 10up/gutenberg-best-practices has similar content.

Fixed in 3c973db

All these items have been adressed