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

Streamline README.md #318

Merged
merged 1 commit into from
Feb 25, 2021
Merged

Streamline README.md #318

merged 1 commit into from
Feb 25, 2021

Conversation

imjasonh
Copy link
Member

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.

@google-cla google-cla bot added the cla: yes label Feb 23, 2021
@imjasonh imjasonh force-pushed the readme branch 3 times, most recently from afe513d to 2976743 Compare February 23, 2021 18:57
@codecov-io
Copy link

Codecov Report

Merging #318 (2976743) into main (a6442e6) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a6442e6...2976743. Read the comment docs.

Copy link
Contributor

@tstromberg tstromberg left a 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.

Copy link
Collaborator

@jonjohnsonjr jonjohnsonjr left a 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:

  1. I'd keep the aknowledgements, since it's useful for someone interesting in digging into this stuff more.
  2. Maybe we should stick source <(ko completion) somewhere?

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

@afrittoli afrittoli left a 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 -

@imjasonh
Copy link
Member Author

kustomize build config | ko resolve -f -

Ooh fun, added as an FAQ

@imjasonh
Copy link
Member Author

imjasonh commented Feb 24, 2021

  1. I'd keep the acknowledgements, since it's useful for someone interesting in digging into this stuff more.
  2. Maybe we should stick source <(ko completion) somewhere?

Done and done!

@n3wscott
Copy link
Contributor

/lgtm

@jonjohnsonjr
Copy link
Collaborator

LGTM, curious if @mattmoor has any feedback

Copy link

@patflynn patflynn left a 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() {

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!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@imjasonh imjasonh merged commit c0b2a1c into ko-build:main Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants