Overview

Sibling of #3461490: Document the current JSON-based data model, and describe in an ADR for all things components — i.e. completely ignoring the data model, but instead focusing on how components (currently only SDCs) are discovered and made available in XB.

Just like #3461490 provided an overview to the data modeling person (site builder + back-end developer, if you will), this should provide an overview to the component tree creating person (site builder + front-end developer + content creator).

(Note that it's different from #3446083: Document supported component modeling approaches in that this one is about technical specifics, whereas that one is about the component modeling XB aims to support.)

This should tie together/provide an overview of not just the still-in-progress-but-will-happen-soon things (such as #3463999: Auto-create/update Component config entities for all discovered SDCs that meet XB's minimum criteria), but also the many future steps we need to take to leap beyond SDCs:

This ADR, just like that in #3461490, will be superseded. But it's important to capture the status quo, especially prior to DrupalCon Barcelona aka #3454094: Milestone 0.1.0: Experience Builder Demo.

Proposed resolution

User interface changes

None.

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

Wim Leers created an issue. See original summary.

wim leers’s picture

Title: Document the current component discovery + criteria, and describe in an ADR » Document the current component discovery + SDC criteria, and describe in an ADR
Issue tags: +ADR, +DX (Developer Experience)
wim leers’s picture

Component: Page builder » Documentation
Assigned: Unassigned » wim leers

wim leers’s picture

Title: Document the current component discovery + SDC criteria, and describe in an ADR » Document the current component discovery + SDC criteria + `Component` config entity, and describe in an ADR
Issue summary: View changes

Expanding this to also document config management bits, because the "compatible-SDC-captured-as-config" principle intrinsically connects the two.

wim leers’s picture

Component: Documentation » Config management
Assigned: wim leers » f.mazeikis
Status: Active » Needs review
wim leers’s picture

f.mazeikis’s picture

Status: Needs review » Needs work

Additional docs, ADRs and context is really neat!
Posted some nitpicks and minor feedback about sections that I personally found difficult to follow.

wim leers’s picture

Status: Needs work » Needs review

All feedback addressed! 🏓

f.mazeikis’s picture

Status: Needs review » Reviewed & tested by the community

All the feedback from me and Dave has been addressed, moving to RTBC

wim leers’s picture

Assigned: f.mazeikis » Unassigned

Thanks for your very thoughtful feedback, both of you! 😊🙏 You both made this much better!

  • wim leers committed 2dbe5969 on 0.x
    Issue #3468112 by wim leers, f.mazeikis, longwave: Document the current...
wim leers’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.