Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feedback from community member #219

Closed
luebken opened this issue Dec 2, 2022 · 3 comments
Closed

Feedback from community member #219

luebken opened this issue Dec 2, 2022 · 3 comments
Assignees
Labels
feedback Issues tracking general docs feedback

Comments

@luebken
Copy link

luebken commented Dec 2, 2022

Some feedback from a handsome community member in German thread in Linkedin:

What could be improved in the docs:

  • Overview of the Crossplane CRDs and how they are opinionated.

  • What is CompositionRef, ToCompositeFieldPath, FromCompositeFieldPath. Overview. Explanation

  • Relation of Claims, XRD, Compositions + XRs. Is documented. Still not clear.

  • What happens if there is no defaultCompositionRef and there are multiple Compositions.

  • For every opinionated Crossplane extension, there should be a section with explanation and diagram.

  • How to Monitoring

via @erkules

@erkules
Copy link

erkules commented Dec 3, 2022

Another example:
It is highly irritating when you want to Check Compositions and the side starts with XRs (https://docs.crossplane.io/v1.10/concepts/composition/)
Please make it clear i.e.:
As an Infra I create Compostions and XRDs and the Consumer creates the Claim/XR.

Maybe using Kubernetes analogies would be fine aka:
While we still have our opinionated way [link2diff2NormaloCRDs] to use CRDs there is basically nothing new.

Think about Compositions as a declarative way to configure/create specific Controllers and XRDs are just opinionated CustomResourceDefinitions. So they create the CRD for the Consumer to use. We call it XR/Claim because ??? (placeholder for explanation Claim "vs" XR). In the end a "ConsumerController" picks (ok that would be the K8s-way in Crossplane it is the other way around) the Claim/Object and creates/configures(/watches?) it.

An approach like this would use patterns we know already and Compositions wouldn't be a Miracle Resource anymore (scnr).

thx4Crossplane kinda interesting <3

@plumbis plumbis added the feedback Issues tracking general docs feedback label Jan 12, 2023
@plumbis
Copy link
Collaborator

plumbis commented Feb 1, 2023

Some of these points are (hopefully) addressed with the v1.11 docs update.

Overview of the Crossplane CRDs and how they are opinionated.
...
Relation of Claims, XRD, Compositions + XRs. Is documented. Still not clear.

A new intro page introduces XRDs and CRDs and puts them into context. A new AWS quickstart page also tries to explain this in simple terms.

@plumbis
Copy link
Collaborator

plumbis commented Jul 26, 2023

Fixed in #475

@plumbis plumbis closed this as completed Jul 26, 2023
@plumbis plumbis self-assigned this Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback Issues tracking general docs feedback
Projects
None yet
Development

No branches or pull requests

3 participants