feat: update Meteor Admin SDK CMS element to Vue.js 3#2296
feat: update Meteor Admin SDK CMS element to Vue.js 3#2296Dominik Grothaus (dgrothaus-sw) wants to merge 2 commits into
Conversation
Updates the examples and code used in the documentation to match Vue.js 3 used in Meteor for Shopware 6.7. Added examples of how to not only add the element to the replace modal but to the block picker, too. Changed to tone to match other documentation. Removed the code for Shopware < 6.7 as the docs for Shopware < 6.7 are separate. Updated the screenshots to mirror the current visuals of the administration.
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for adding CMS elements via the Meteor Admin SDK to match the Vue 3 (SFC) approach used with Meteor for Shopware 6.7, and improves discoverability by documenting how to register both a CMS block (block picker) and a CMS element (replacement modal).
Changes:
- Update the “Add CMS Element” Admin SDK guide to Vue 3 SFC-based examples and add
registerCmsBlockusage alongsideregisterCmsElement. - Clarify the relationship between declarative
cms.xmlblocks vs fully custom Admin SDK elements, including cross-linking between the guides. - Extend the spellcheck wordlist with “discoverable”.
Reviewed changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| guides/plugins/apps/content/cms/add-custom-cms-blocks.md | Clarifies cms.xml block limitations and links to the Admin SDK element approach. |
| guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md | Reworks the guide to Vue 3 SFC examples, adds block+element registration guidance, and updates sample snippets. |
| .wordlist.txt | Adds “discoverable” to the wordlist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Dominik Grothaus (@dgrothaus-sw) did you see the comments by Copilot? Can you please check and solve those? I can not validate those from a dev POV. Also, a PR snuck in yesterday that would need some attention (I think mostly structural). I can take over this, if you are busy. |
|
Micha Hobert (@Isengo1989) I've gone through the comments and they don't really provide value. In the first iteration, Copilot did not mention any of these issues. While writing the docs, I followed the documentation to create a new app to see if the instructions work and it works fine. The example is working fine without the changes Copilot suggested. Regarding the changes from the PR: I'll resolve the conflicts. |
Summary
Updates the examples and code used in the documentation to match Vue.js 3 used in Meteor for Shopware 6.7.
Added examples of how to not only add the element to the replace modal but to the block picker, too.
Changed to tone to match other documentation.
Removed the code for Shopware < 6.7 as the docs for Shopware < 6.7 are separate.
Updated the screenshots to mirror the current visuals of the administration.
Related links
Closes #1914
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes