-
Notifications
You must be signed in to change notification settings - Fork 405
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
Streamline README.md #318
Streamline README.md #318
Conversation
afe513d
to
2976743
Compare
Codecov Report
@@ Coverage Diff @@
## main #318 +/- ##
=======================================
Coverage 38.07% 38.07%
=======================================
Files 33 33
Lines 1513 1513
=======================================
Hits 576 576
Misses 844 844
Partials 93 93 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Talk about a huge refactor! This new version seems to cover all the important getting-started bases, and isn't nearly as intimidating. Users like myself will no longer have an excuse to shy away from ko.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, love the smoother on-ramp.
Some thoughts:
- I'd keep the aknowledgements, since it's useful for someone interesting in digging into this stuff more.
- Maybe we should stick
source <(ko completion)
somewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, thank you!
It might be worth mentioning somewhere that the -f
param supports input from stdin through the syntax -f -
. This is useful for instance to do something like
kustomize build config | ko resolve -f -
Ooh fun, added as an FAQ |
Done and done! |
/lgtm |
LGTM, curious if @mattmoor has any feedback |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You rock Jason! This is exactly the information I needed when I was trying to use Ko to containerize an app to deploy to Cloud Run a while back. I love the format, and all the content around static resources is a huge help. Would have saved me a bundle of time!
in all contexts. | ||
Then, in your `main.go`: | ||
```go | ||
func main() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wish this example had been there two weeks ago!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, it is a pretty good pattern: https://github.com/knative-party/site/blob/main/site.go
Rendered
Recent feedback (1, 2) indicate that it's not clear enough that
ko
is a useful option for simply building container images, separate from its Kubernetes support.This reorders README.md to start with installation options, then highlight
ko publish
first, then sidetrack into configuration options, then mention Kubernetes support (ko resolve
->ko apply
->ko delete
), and end with an FAQ.It's about 60% as many lines and half as many characters as the current README.