Backoffice: Add Working with Media documentation (17.6 & 18.1) - #8187
Conversation
Add a "Working with Media" foundation article covering the umb-media-thumbnail and umb-media-image components, the imaging/media/url repositories, and showing media in a custom block view. Extend the Block List custom view tutorial with a section on displaying the block's media. Also fix the tutorial's render examples to use the featureName property alias (was headline, which did not match the Feature element type) and add HMAC to the Vale acronym exceptions list. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Thanks for opening this PR! 🎉 Quick question: Does this PR include any AI-generated content? AI tools are absolutely welcome here! We only ask that you follow our AI contribution guidelines to help keep the documentation consistent and trustworthy. Drop a quick comment to let us know! |
There was a problem hiding this comment.
Pull request overview
Adds new “Working with Media” foundation documentation for backoffice extension developers (for both v17 and v18 docs), and extends the Block List custom view tutorial to include rendering media via umb-media-thumbnail. It also updates the tutorial examples to use the correct featureName alias and adds HMAC to Vale acronym exceptions.
Changes:
- Add “Working with Media” foundation article to both
17/and18/, and link it from the docs navigation. - Extend the Block List custom view tutorial with a section showing how to display a block’s Media Picker value using
umb-media-thumbnail. - Update tutorial render examples to use
featureNameand addHMACto Vale acronym exceptions.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| 18/umbraco-cms/SUMMARY.md | Adds the new media foundation page to the v18 navigation. |
| 18/umbraco-cms/extend-your-project/tutorials/creating-custom-views-for-blocklist.md | Updates alias usage and adds media rendering guidance/snippet. |
| 18/umbraco-cms/extend-your-project/backoffice-extensions/foundation/working-with-media.md | New v18 media guidance page covering components + repositories. |
| 17/umbraco-cms/SUMMARY.md | Adds the new media foundation page to the v17 navigation. |
| 17/umbraco-cms/extend-your-project/tutorials/creating-custom-views-for-blocklist.md | Updates alias usage and adds media rendering guidance/snippet (+17.6 alias note). |
| 17/umbraco-cms/extend-your-project/backoffice-extensions/foundation/working-with-media.md | New v17 media guidance page (includes 17.6 availability notes). |
| .github/styles/UmbracoDocs/Acronyms.yml | Adds HMAC to Vale acronym exceptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarify the tutorial's import snippet so it reads as updating the existing Lit import with `nothing` rather than replacing it (keeping UmbElementMixin and the other imports). Use optional chaining when reading the first resized URL result, consistent with the other examples on the page. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
iOvergaard
added
the
ai-generated
|
Yes — this is AI-assisted. The content was generated with Claude Code under my direction, and I've verified the code samples, APIs, namespaces, and version references against the 17.6 and 18.1 source. Following the AI contribution guidelines and have added the |
…ation/working-with-media.md
…ation/working-with-media.md
📋 Description
Adds a new Working with Media foundation article for backoffice extension developers, in both the
17/and18/documentation, and extends the Block List custom view tutorial with a section on displaying a block's media.The article covers:
umb-media-thumbnail(andumb-media-imagefor the original)--umb-media-thumbnail-backgroundUmbMediaItemRepository/UmbMediaDetailRepositoryUmbImagingRepository/UmbMediaUrlRepositoryThe tutorial's render examples are also corrected to use the
featureNameproperty alias (previouslyheadline, which did not match the Feature element type), andHMACis added to the Vale acronym exceptions.📎 Related Issues (if applicable)
Follows up on umbraco/Umbraco-CMS#23177 (discussion) and umbraco/Umbraco-CMS#23178 (the
umb-media-thumbnailrename + configurable checkerboard background, shipping in 17.6 and 18.1). These live in the CMS repo and are not closed by this docs PR.✅ Contributor Checklist
I've followed the Umbraco Documentation Style Guide and can confirm that:
Product & Version (if relevant)
Umbraco CMS — 17.6 and 18.1.
Deadline (if relevant)
Ideally published alongside the 17.6 and 18.1 releases.
📚 Helpful Resources
🤖 Generated with Claude Code