Skip to content

Added Skill for Building Blocks for EDS when AEM Sites Universal Editor is your Content Source#4

Closed
complexthings wants to merge 2 commits intoadobe:mainfrom
complexthings:aem-sites-ue-block-development
Closed

Added Skill for Building Blocks for EDS when AEM Sites Universal Editor is your Content Source#4
complexthings wants to merge 2 commits intoadobe:mainfrom
complexthings:aem-sites-ue-block-development

Conversation

@complexthings
Copy link
Copy Markdown

Description

Added a new skill building-blocks-xwalk-ue for building AEM Edge Delivery Services blocks when using AEM Sites Universal Editor (xwalk) as the content source. It includes workflow, as well as 2 example blocks (key-value configuration based block and nested block examples), and 11 resource documents covering common mistakes, component definition organization, configuration reading patterns, CSS tokens, data passing, field naming conventions, key-value migration, a migration guide, state management and troubleshooting.

Related Issue

N/A - New contribution

Motivation and Context

When you're working with AEM Sites UE as your content-source the standard skills aren't entirely relevant, and documentation is dispersed between aem.live, experienceleague.adobe.com, the codebase, and in some cases undocumented, roll up your sleeves, just in general figuring it out yourself. I've had a skill rolling for a while, I stripped out my workflow specifics from it, made sure it aligned with the rest of your skills and was referencing them as best possible to remove any duplication.

How Has This Been Tested?

  • Skill structure and content reviewed for completeness and accuracy against AEM Edge Delivery + Universal Editor documentation and best practices.
  • Example blocks include README documentation, component model JSON definitions, CSS, and JavaScript that follow the patterns described in the skill.
  • Try it out

Screenshots (if appropriate):

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Copy Markdown
Collaborator

@shsteimer shsteimer left a comment

Choose a reason for hiding this comment

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

Sorry for delay on review...

In general, I think adding UE specific guidance is a good idea, but have some concerns:

  • should his be a separate skill, or is it better (both in terms of usage and maintenance) as a set of UE specific resource files referenced from the existing building-blocks skill? I can see a case for both, but they seem to share a lot of the same core content, and I don't want to maintain in 2 places unless absolutely necessary, so lean towards the latter. Welcome your thoughts though.
  • The skill adds a lot resources that would need to be maintained, which I think should be consolidated, or replaced by docs links where appropriate:
    • replace example blocks with links to ue-block-collection
    • remove things like field-naming-conventions and component-definition-organization, link to docs instead
    • remove things covered better elsewhere such as css-tokens and resource-loading
  • core skill file is over 700 lines, core guidance is to keep to under 500, can this be slimed down some?
    • the moveInstrumentation guidance appears multiple times in multiple forms. perhaps this could all be replaced with references to a canonical section?

1. **Project blocks** — `blocks/` directory in the current project
2. **Block collections:**
- [AEM Block Collection (xwalk)](https://github.com/adobe-rnd/aem-block-collection-xwalk) — AEM Sites UE-enabled/xwalk blocks (preferred search starting point)
- [AEM Boileraplte Xwalk (xwalk)](https://github.com/adobe-rnd/aem-boilerplate-xwalk) — AEM Sites UE-enabled/xwalk boilerplate
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- [AEM Boileraplte Xwalk (xwalk)](https://github.com/adobe-rnd/aem-boilerplate-xwalk) — AEM Sites UE-enabled/xwalk boilerplate
- [AEM Boilerplate Xwalk (xwalk)](https://github.com/adobe-rnd/aem-boilerplate-xwalk) — AEM Sites UE-enabled/xwalk boilerplate

@complexthings
Copy link
Copy Markdown
Author

Thanks @shsteimer the one I'm using locally has evolved similarly as well since I opened this. I forgot about this PR 😂 so I'm closing it, Looks like you all have other PRs coming in to handle this soon.

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

Successfully merging this pull request may close these issues.

2 participants