kptdev / kpt

Automate Kubernetes Configuration Editing
https://kpt.dev
Apache License 2.0
1.67k stars 226 forks source link

docs: create a human friendly home-page for kpt #3374

Open kostis-codefresh opened 1 year ago

kostis-codefresh commented 1 year ago

Describe your problem

The current home-page for kpt has exactly 0 examples and doesn't explain what kpt is or why do I need it.

It instead forces me to sit down and watch an 11 minute video which assumes that all visitors like to watch videos (which could not be further from the truth)

The text above the video seems like marketing speak to me or something that I would put in a research paper. I am not really sure what exactly is "KRM-driven architecture". Is this defined somewhere? (Also related https://github.com/GoogleContainerTools/kpt/issues/3356)

kpt

It is ok if there is a video for additional information, but not as the sole source of information for a tool.

As a comparison I am attaching the homepage of kustomize that has an example right on the homepage. I can look at the example in 30 seconds and understand what the tool does instead of watching an 11 minute video.

kustomize

bgrant0607 commented 1 year ago

Thanks. Split out replacing the video into a separate issue: #3376

bgrant0607 commented 1 year ago

KRM-driven infrastructure is infrastructure configured via the Kubernetes Resource Model, such as via https://github.com/GoogleCloudPlatform/k8s-config-connector or crossplane.io.

Filed a specific issue to define or remove it: #3377.