Fix link to binary-installation method in README.md #903
Conversation
k8s-ci-robot
added
cncf-cla: yes
README.md
Outdated
|
|
||
| Our entire list of installation methods are located in our [installation.md](/docs/installation.md) document. | ||
|
|
||
| Installation methods: | ||
| - [Binary (Prefered method)](README.md) | ||
| - [Binary (Preferred method)](#binary-installation) |
There was a problem hiding this comment.
I think this should be /docs/installation.md#binary-installation otherwise lgtm.
There was a problem hiding this comment.
We don't have a section named binary-installation in /docs/installation.md (actual method is there though)
but the same installation method is present in README.md itself, so I thought linking to the section from README.md will be better solution.
should I link to /docs/installation.md instead?
There was a problem hiding this comment.
@bhavin192 sorry, link to: https://github.com/kubernetes/kompose/blob/master/docs/installation.md#github-release
so: docs/installation.md#github-release
There was a problem hiding this comment.
@cdrage I got it now, so the section is like a index of installation.md but again won't it be little bit confusing for user? as we have instructions there on the README.md itself (for binary installation) and we are redirecting to installation.md for the same instructions?(installation.md also explains Nightly releases though)
Can we have list of all methods after the Binary Installation method (README.md) ?
or may be I'm over thinking about this :-/
|
Thanks @bhavin192 for your contribution, after changes suggested by @cdrage , good to go :) |
|
IMO. Having it separate would be best as it shows other methods for
installation too.
…On Jan 6, 2018 08:34, "Bhavin Gandhi" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In README.md
<#903 (comment)>:
>
Our entire list of installation methods are located in our [installation.md](/docs/installation.md) document.
Installation methods:
- - [Binary (Prefered method)](README.md)
+ - [Binary (Preferred method)](#binary-installation)
@cdrage <https://github.com/cdrage> I got it now, so the section is like
a index of installation.md but again won't it be little bit confusing for
user? as we have instructions there on the README.md itself (for binary
installation) and we are redirecting to installation.md for the same
instructions?
Can we have list of all methods after the Binary Installation method (
README.md) ?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#903 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AGH-oGZ0OwZ7dSgFl92gl0rLCmTi4N4mks5tH3Z-gaJpZM4RLpLu>
.
|
in README.md. Also fix typo in word preferred Signed-off-by: Bhavin Gandhi <[email protected]>
|
LGTM! Thanks! |
Now it links to the section of same file.
Also fixes typo in word preferred.
fixes #902