docs icon indicating copy to clipboard operation
docs copied to clipboard

Guide to writing a composition

Open negz opened this issue 4 months ago • 2 comments

What's Missing?

We have getting started guides but they just say "use this composition". We also have composition docs, but they're more of a reference and explaining the general concepts. It'd be neat to have a page walking you though writing your first composition.

Ideally without picking any one language. Maybe a lang selector to let you pick one of a few examples ala the other getting started guides.

This could help with how to think about compositions in general - e.g. the fact that you're really writing a chunk of a reconcile loop.

negz avatar Aug 26 '25 19:08 negz

This could help with how to think about compositions in general - e.g. the fact that you're really writing a chunk of a reconcile loop.


Communicating that idea has been a challenge for me. I often run into engineers familiar with Kubernetes controllers/operators, and they tend to collapse the conventions of a full operator reconcile loop into composition step/function concepts, making it harder to reason that each step is really just a small "specialized" slice of the larger reconcile process.

Working on a few things on my end but if this stays open long enough, I'll try to give the documentation a pass.

vibe avatar Aug 27 '25 08:08 vibe

Perhaps a practical use of where and how observed and desired state can be used.

HighonAces avatar Sep 10 '25 19:09 HighonAces