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

Update README.md with usage and known issues. #100

Merged
merged 1 commit into from
May 26, 2016

Conversation

dlorenc
Copy link
Contributor

@dlorenc dlorenc commented May 23, 2016

@luxas
Copy link
Member

luxas commented May 24, 2016

Be aware that you have two sections that explains nearly the same thing: https://github.com/dlorenc/minikube/blob/readme/README.md#usage; that's running minikube only, and https://github.com/dlorenc/minikube/blob/readme/README.md#run-instructions that's running out/minikube

Consider merging them or something

@aaron-prindle
Copy link
Contributor

aaron-prindle commented May 25, 2016

I think that the usage, features, and known issues section are good. As @luxas mentioned though, we should probably try to keep the Usage and Run Instructions section consistent regarding using: minikube OR ./out/minikube start. Or we could perhaps merge them as I don't think the 'kubectl config' commands and without them the Run Instructions section is very similar to the Usage section.

@dlorenc
Copy link
Contributor Author

dlorenc commented May 25, 2016

Thanks for the review. I reorganized it a bit so the ./out/minikube is only mentioned in the development instructions, the "usage" section is now meant for end users who will have minikube on their path.

Kubernetes is available at https://192.168.99.100:443.

$ $(minikube docker-env)
$ docker build -t helloworld .
Copy link
Member

Choose a reason for hiding this comment

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

As a user, I would wonder what this is... Is it a built-in thing or is it some required step or is it just a demo... and how may I try that demo out in that case...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Clarified above that this is just a demo, and added a link to the tutorial.

@dlorenc dlorenc force-pushed the readme branch 2 times, most recently from c0fda77 to 031e607 Compare May 25, 2016 13:34
@luxas
Copy link
Member

luxas commented May 26, 2016

LGTM

@dlorenc dlorenc merged commit a7c5b82 into kubernetes:master May 26, 2016
@dlorenc dlorenc deleted the readme branch May 26, 2016 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants