-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Added instructions for installing kn #2045
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
Conversation
RichieEscarez
left a comment
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.
@abrennan89 These stand alone installation steps should be moved into the reference section. Which would be used only if someone does not follow the Serving or Eventing install instructions. Meaning that the kn installation should be added to the Serving or Eventing flows and done there by default (not a separate disconnected step).
|
I think we can at least use a link from Serving/Eventing installs to these instructions, vs. copying them into those topics as well. I'm imagining we'll add an optional step to the installation guides that points to these steps for installing kN. I've been talking with Richie, and I think what we're thinking is that the /client/ folder should be moved into the /reference/ section, but then this page on installing the client should live in the /install/ folder. I think that's all captured in the nav proposal: https://docs.google.com/spreadsheets/d/1L3EAeTX7RRdZhcQZeNmxwN4DCncuImCXA5A1_KQvwSk/edit#gid=413198505 I apologize for not cross-referencing your first PR with the nav proposal; I should have! Does that seem reasonable, @abrennan89 ? |
|
Adding a link to these docs from Serving, Eventing and the install section sounds like a good plan @samodell - I was sort of waiting to see if we could include the content instead, which is why I was asking about the re-use mechanism for .md files, but you can let me know if you'd prefer to include the file or just link out to this doc. If we move the Client section to the Reference section, where would the user stories that we document as tasks live? Would these just be split out and included under Serving and Eventing? That makes sense to me, but the suggestion to have a separate Client section at the same level as Serving and Eventing also came from @rhuss , so I'd just like to check with you Roland that there are no Thanks folks for all the input and your patience! |
a4a5062 to
54980e3
Compare
|
@abrennan89: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
samodell
left a comment
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.
Thanks for taking these docs on, Ashleigh!
| type: "docs" | ||
| --- | ||
|
|
||
| ## Install `kn` using the nightly executable binary |
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.
Shouldn't we also offer installing the latest release of the client? I'm not sure if most users want to download and work with the nightly release.
https://github.com/knative/client/blob/master/docs/README.md has instructions on downloading the most recent release.
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 also think we should offer some information about who should install the nightly executable, and probably a warning that it may not be super stable?
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.
The 'latest' release is also covered under the kn container images section of the docs: https://knative.dev/development/install/install-kn/
I will check in with the CLI team about what to put for a warning/audience note about the nightly executable.
| go install ./cmd/kn | ||
| ``` | ||
|
|
||
| ## `kn` container images |
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.
What are these container images for? Can we explain what user might do with these?
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 added this to cover installing 'latest' - I think it's just how the CLI is installed if you're not using the binaries or Go methods.
The information came from: https://github.com/knative/client/blob/master/docs/README.md
i.e.
To use the kn container image:
Nightly: gcr.io/knative-nightly/knative.dev/client/cmd/kn
Latest release: gcr.io/knative-releases/knative.dev/client/cmd/kn
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, samodell The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Fixes #2044
Proposed Changes