Skip to content

[Docs] The Studio Example Bundle now ships its build as an archive - #4124

Merged
ValeriaMaltseva merged 2 commits into
2026.3from
doc-example-bundle-ships-archive
Sep 30, 2026
Merged

ValeriaMaltseva merged 2 commits into
2026.3from
doc-example-bundle-ships-archive

Conversation

@ValeriaMaltseva

Copy link
Copy Markdown
Contributor

Follow-up to pimcore/studio-example-bundle#40, which rolls out the packaged frontend-build
(zip archive + warmup extraction) to the Studio Example Bundle — see pimcore/platform-version#501.

Two statements in the Extending docs stop being true once that merges:

  • 04_Shipping_the_Frontend_Build_as_an_Archive.md presents the Example Bundle as the example of
    the "commit the expanded build directory" option. It is now an example of the third option, the
    committed archive, so it moves to that bullet.
  • 03_Registering_the_Frontend_Build.md links to the Example Bundle's
    src/Webpack/WebpackEntryPointProvider.php as "a complete working example" of the plain provider
    described on that page. That class now implements BuildArchiveProviderInterface via
    BuildArchiveExtractionTrait. The link moves to the bundle's config/services.yaml, which is still
    a faithful example of the tagging the page is about, with a pointer to page 04 for the class itself.

Docs only — no code changes.

🤖 Generated with Claude Code

The Example Bundle moved from a committed public/build/ directory to a
committed build-dist/build-<id>.zip (pimcore/studio-example-bundle#40),
so it is no longer an example of the "commit the expanded build
directory" option, and the provider linked from Registering the Frontend
Build is no longer a plain provider.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings September 22, 2026 09:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The documentation depends on external PR pimcore/studio-example-bundle#40, which has not yet merged.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 2 Low severity

Open (2)
What changed in this PR

Updates frontend-build documentation to reflect the Studio Example Bundle’s planned archive-based distribution.

Changes:

  • Reclassifies the Example Bundle under committed build archives.
  • Links service tagging guidance to its services.yaml.
File Description
doc/​04_Extending/​04_Shipping_the_Frontend_Build_as_an_Archive.md Updates archive-shipping examples.
doc/​04_Extending/​03_Registering_the_Frontend_Build.md Revises the Example Bundle reference.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread doc/04_Extending/03_Registering_the_Frontend_Build.md
Comment thread doc/04_Extending/04_Shipping_the_Frontend_Build_as_an_Archive.md
@ValeriaMaltseva
ValeriaMaltseva marked this pull request as draft September 22, 2026 09:30
@ValeriaMaltseva
ValeriaMaltseva changed the base branch from 2026.2 to 2026.3 September 24, 2026 08:33
@ValeriaMaltseva ValeriaMaltseva added this to the 2026.3.1 milestone Sep 24, 2026
@ValeriaMaltseva
ValeriaMaltseva marked this pull request as ready for review September 30, 2026 14:00
pimcore/studio-example-bundle#40 added the build-id logic above the entry
config, moving `main: './js/src/main.ts'` from line 49 to line 59.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sonarqubecloud

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approved

The documentation-only changes match the merged Example Bundle implementation and its current links.

Review effort: Balanced
Findings: None

Resolved since last review (2)

@ValeriaMaltseva
ValeriaMaltseva merged commit 85cdf42 into 2026.3 Sep 30, 2026
14 checks passed
@ValeriaMaltseva
ValeriaMaltseva deleted the doc-example-bundle-ships-archive branch September 30, 2026 15:48
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants