Clarify readme #407
Merged
Clarify readme #407
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Try make it slightly clearer what k0s is and does, and how it is different from other kubernetes distros by - Remove redundant and non essential text - List key features early (above the demo) Signed-off-by: Natanael Copa <ncopa@mirantis.com>
ncopa
requested review from
mikhail-sakhnov and
jasmingacic
and removed request for
a team
|
I think I forgot to add a line about where to find the |
building and smoke testing should probably in a separate document, but keep it at the bottom for now. Signed-off-by: Natanael Copa <ncopa@mirantis.com>
ncopa
force-pushed
the
clarify-readme
branch
from
d74fc14 to
88f71a6
Compare
jasmingacic
suggested changes
Nov 16, 2020
| ``` | ||
| make check-basic | ||
| ``` | ||
|
|
||
| ## Cluster bootstrapping | ||
|
|
||
| Move the built `k0s` binary to each of the nodes. |
There was a problem hiding this comment.
I'd suggest adding this too:
curl -SsLf get.k0s.sh
There was a problem hiding this comment.
I can't comment on the line below but I'd also give an example with enable-worker
There was a problem hiding this comment.
Do we need --enable-worker example in the readme when we have it in the FAQ?
There was a problem hiding this comment.
I'm thinking it is most likely how someone is going to try k0s
Signed-off-by: Natanael Copa <ncopa@mirantis.com>
ncopa
force-pushed
the
clarify-readme
branch
from
88f71a6 to
745f064
Compare
It is less friction as it does not need authentication. Signed-off-by: Natanael Copa <ncopa@mirantis.com>
Add a super short quick getting started section at the top Signed-off-by: Natanael Copa <ncopa@mirantis.com>
ncopa
force-pushed
the
clarify-readme
branch
from
0706954 to
52e3f58
Compare
jasmingacic
approved these changes
Nov 17, 2020
jnummelin
approved these changes
Nov 17, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR Includes
Try make it slightly clearer what k0s is and does, and how it is different from other kubernetes distros by