Doc and otherwise make clearer how the 'html' preview element is generated

Created on 8 April 2025, about 2 months ago

Overview

Follow-up to #3512385-15: Changes to code components are not visible in global regions until published

To write a test for that I really wanted to understand how the 'html' preview element was generated and how it should be determined if we are "in preview"

I just now realize how the html previewing works. I wasn't involved in these issue but wondering if we should document better how these classes relate to each other

  1. PreviewEnvelopeViewSubscriber
  2. PreviewEnvelope
  3. XBPreviewRenderer
  4. XbPageVariant
  5. RenderEventsSubscriber
  6. ApiLayoutController

This is all very complicated and there is no where to see who all these related to each other

Proposed resolution

Wim suggested in #3512385-16: Changes to code components are not visible in global regions until published a class-level docblock on \Drupal\experience_builder\Controller\ApiLayoutController

Lets do that and also see if any of the class names should renamed to make this clearer

User interface changes

📌 Task
Status

Active

Version

0.0

Component

Documentation

Created by

🇺🇸United States tedbow Ithaca, NY, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024