Skip to content

consider changing the default function for composition getting started guide #1075

@jbw976

Description

@jbw976

The composition getting started guide currently features function-patch-and-transform as the default tab. We should update this to a more modern function that represents a better UX offered by more capable and powerful functions.

The getting started guide is the first composition experience most new Crossplane users will see, so the default tab choice matters. We currently show multiple composition function options:

  • Patch and Transform (current default)
  • Python
  • Go Templating
  • KCL
  • Pythonic

After some maintainer discussion, the community download numbers make a compelling case for function-go-templating as the default:

  • function-go-templating is among the most downloaded composition functions in crossplane-contrib
  • Go templating is a familiar experience for users coming from Helm and other Kubernetes tooling
  • It provides a simple, approachable first experience without requiring knowledge of a full programming language or exposing too many function protocol details

Long term we may want to consider Python if we invest further in the SDK and DevEx, but function-go-templating would make a good choice for the time being.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions