Improve "Installing the Knative CLI" #2230

MIBc · 2020-02-21T10:18:14Z

Proposed Changes

Make install kn with Go more detailed.
Give example on how to run kn using container.

knative-prow-robot · 2020-02-21T10:18:29Z

Hi @MIBc. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

docs/install/install-kn.md

MIBc · 2020-02-21T10:29:18Z

/assign @rhuss

rhuss

@MIBc thanks a lot for your PR ! Really appreciated for taking care.

There are some issues though as pointed out below. We need to fix that, but I'm on PTO next week.
Please check with @navidshaikh in the meantime.

rhuss · 2020-02-21T20:33:07Z

docs/install/install-kn.md

+You can run `kn` from container. For example:
+  ```bash
+  docker pull https://gcr.io/knative-releases/knative.dev/client/cmd/kn
+  docker run --rm --name <your-container-name> -v "$HOME/.kube/config:<your-kubeconfig-path>" gcr.io/knative-releases/knative.dev/client/cmd/kn:latest service list


No need to select a name (just leave that out)

Instead of <your-kubeconfig-path> we need to provide the concrete directory.

Still have to figure that out, but @navidshaikh how is this image called in the tekton integration ?

In general it doesnt make sense to add placeholder in an installation intstructions if it is not explained what they should be (and of course shouldn't be added if not needed)

We don't need to touch anything for kubeconfig while working with tekton.

IMO, we should remove this command example and add a sub-section here for example: 'Using kn with Tekton' which links to the kn catalog task at https://github.com/tektoncd/catalog/tree/master/kn

May be we can both introduce Running kn in docker and Running kn with tekton task. For some users, they are not familiar with tekton.

docs/install/install-kn.md

MIBc · 2020-03-12T07:39:38Z

Do you have more suggestion？ @rhuss

rhuss

Please see some suggestions inline. If you like I can help in the wording.

docs/install/install-kn.md

rhuss · 2020-03-23T09:52:57Z

/ok-to-test

evankanderson · 2020-04-09T22:14:40Z

@rhuss any more comments? Is this good to go?

rhuss

Looks good, thanks ! (and sorry for the delay).

In a followup PR we should also describe how to install with brew on macOS.

/lgtm

rhuss · 2020-04-20T08:23:39Z

/assign @averikitsch

matzew

/lgtm
/approve

lionelvillard · 2020-04-22T12:56:39Z

/approve

MIBc · 2020-05-18T15:54:34Z

/assign @averikitsch

abrennan89

@MIBc added some comments. Thanks for adding this PR 🙂

abrennan89 · 2020-06-15T17:59:24Z

docs/install/install-kn.md

@@ -26,6 +26,22 @@ To install the `kn` Client, you must download the executable binary for your sys

 You must place the executable binary in your system path, and make sure that it is executable.

+## Install `kn` using Go
+1. Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.


Make this a prerequisite instead of step 1.

abrennan89 · 2020-06-15T17:59:45Z

docs/install/install-kn.md

@@ -26,6 +26,22 @@ To install the `kn` Client, you must download the executable binary for your sys

 You must place the executable binary in your system path, and make sure that it is executable.

+## Install `kn` using Go
+1. Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.
+1. Check out the [Client repository](https://github.com/knative/client).


Suggested change

1. Check out the [Client repository](https://github.com/knative/client).

1. Check out the [Client repository](https://github.com/knative/client):

abrennan89 · 2020-06-15T18:00:25Z

docs/install/install-kn.md

+  ```bash
+  hack/build.sh -f
+  ```
+1. Move `kn` into your system path, and verify whether kn is working properly. For example:


Suggested change

1. Move `kn` into your system path, and verify whether kn is working properly. For example:

1. Move `kn` into your system path, and verify that `kn` commands are working properly. For example:

abrennan89 · 2020-06-15T18:01:00Z

docs/install/install-kn.md

@@ -34,3 +50,16 @@ Links to either the nightly container image or the latest stable container image

 - [Nightly container image](https://gcr.io/knative-nightly/knative.dev/client/cmd/kn)
 - [Latest release](https://gcr.io/knative-releases/knative.dev/client/cmd/kn)
+
+You can run `kn` from container. For example:


Suggested change

You can run `kn` from container. For example:

You can run `kn` from a container image. For example:

abrennan89 · 2020-06-15T18:02:21Z

docs/install/install-kn.md

+You can also [run kn using Tekton](https://github.com/tektoncd/catalog/tree/master/kn).
+
+## What's next
+Now that you have installed `kn` in your system. To learn more about `kn`, you can read our [document](https://github.com/knative/client/blob/master/docs/cmd/kn.md).


Suggested change

Now that you have installed `kn` in your system. To learn more about `kn`, you can read our [document](https://github.com/knative/client/blob/master/docs/cmd/kn.md).

To learn more about using `kn`, see the [documentation](https://github.com/knative/client/blob/master/docs/cmd/kn.md).

I'd also add a comment here to make sure this gets updated to a link within the docs at some point, rather than the client repo. @rhuss cc'ing you since you might want to update this once there's a kn reference section in docs.

Thanks for your comments.

abrennan89 · 2020-06-30T16:06:44Z

@MIBc just checking in on the status of this one - any plans to update based on the comments?
Thanks.

MIBc · 2020-07-01T01:19:01Z

I will update it asap.

abrennan89 · 2020-07-01T15:23:44Z

@MIBc thanks for the changes, is this ready to merge now?

rhuss

one minor update, otherwise looks good for me now (sorry for the delay)

I a followup PR we should also document how to install via brew on macOs. (See https://github.com/knative/homebrew-client)

rhuss · 2020-07-06T09:45:38Z

docs/install/install-kn.md

@@ -26,6 +26,22 @@ To install the `kn` Client, you must download the executable binary for your sys

 You must place the executable binary in your system path, and make sure that it is executable.

+## Install `kn` using Go
+**Prerequisite:** Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.


It's 1.14 now

rhuss · 2020-07-06T09:47:19Z

docs/install/install-kn.md

@@ -26,6 +26,22 @@ To install the `kn` Client, you must download the executable binary for your sys

 You must place the executable binary in your system path, and make sure that it is executable.

+## Install `kn` using Go
+**Prerequisite:** Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.


Suggested change

**Prerequisite:** Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.

**Prerequisite:** Building `kn` requires Go v1.14 or newer. You will first need a working Go environment.

* Make `install kn with Go` more detailed. * Give example on how to run kn using container.

abrennan89 · 2020-07-07T19:52:55Z

/lgtm
/approve

knative-prow-robot · 2020-07-07T19:53:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, lionelvillard, matzew, MIBc, rhuss

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:

~~OWNERS~~ [abrennan89]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Feb 21, 2020

knative-prow-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 21, 2020

mattmoor reviewed Feb 21, 2020

View reviewed changes

docs/install/install-kn.md Outdated Show resolved Hide resolved

knative-prow-robot requested review from mattmoor and n3wscott February 21, 2020 10:18

MIBc commented Feb 21, 2020

View reviewed changes

docs/install/install-kn.md Outdated Show resolved Hide resolved

knative-prow-robot assigned rhuss Feb 21, 2020

rhuss suggested changes Feb 21, 2020

View reviewed changes

sebgoa suggested changes Feb 23, 2020

View reviewed changes

docs/install/install-kn.md Outdated Show resolved Hide resolved

docs/install/install-kn.md Show resolved Hide resolved

navidshaikh reviewed Feb 24, 2020

View reviewed changes

docs/install/install-kn.md Outdated Show resolved Hide resolved

knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 2, 2020

MIBc force-pushed the client branch from 921b1c5 to 901084e Compare March 12, 2020 07:25

knative-prow-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 12, 2020

MIBc force-pushed the client branch 2 times, most recently from 2c9688b to 7827f2a Compare March 12, 2020 07:38

MIBc force-pushed the client branch from 7827f2a to 2de6d47 Compare March 12, 2020 07:43

rhuss suggested changes Mar 12, 2020

View reviewed changes

docs/install/install-kn.md Outdated Show resolved Hide resolved

docs/install/install-kn.md Outdated Show resolved Hide resolved

docs/install/install-kn.md Outdated Show resolved Hide resolved

MIBc force-pushed the client branch from 2de6d47 to b30fcb6 Compare March 13, 2020 02:07

knative-prow-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 23, 2020

rhuss approved these changes Apr 16, 2020

View reviewed changes

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 16, 2020

knative-prow-robot assigned averikitsch Apr 20, 2020

averikitsch removed their assignment Apr 20, 2020

matzew approved these changes Apr 22, 2020

View reviewed changes

knative-prow-robot assigned matzew Apr 22, 2020

knative-prow-robot assigned averikitsch May 18, 2020

averikitsch removed their assignment May 19, 2020

abrennan89 suggested changes Jun 15, 2020

View reviewed changes

abrennan89 removed request for mattmoor and n3wscott June 15, 2020 18:05

abrennan89 self-assigned this Jun 15, 2020

MIBc force-pushed the client branch from b30fcb6 to 94f56c9 Compare July 1, 2020 13:49

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 1, 2020

rhuss reviewed Jul 6, 2020

View reviewed changes

Improve "Installing the Knative CLI"

5acb4f7

* Make `install kn with Go` more detailed. * Give example on how to run kn using container.

MIBc force-pushed the client branch from 94f56c9 to 5acb4f7 Compare July 7, 2020 08:46

knative-prow-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 7, 2020

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2020

knative-prow-robot added the approved label Jul 7, 2020

knative-prow-robot merged commit 3ebc1ec into knative:master Jul 7, 2020

MIBc mentioned this pull request Aug 28, 2020

REQUEST: New membership for MIBc knative/community#243

Closed

rhuss mentioned this pull request Sep 11, 2020

Update "Installing the Knative CLI" on knative.dev & in README knative/client#648

Closed

	1. Check out the [Client repository](https://github.com/knative/client).
	1. Check out the [Client repository](https://github.com/knative/client):

	1. Move `kn` into your system path, and verify whether kn is working properly. For example:
	1. Move `kn` into your system path, and verify that `kn` commands are working properly. For example:

	You can run `kn` from container. For example:
	You can run `kn` from a container image. For example:

	Now that you have installed `kn` in your system. To learn more about `kn`, you can read our [document](https://github.com/knative/client/blob/master/docs/cmd/kn.md).
	To learn more about using `kn`, see the [documentation](https://github.com/knative/client/blob/master/docs/cmd/kn.md).

	Prerequisite: Building `kn` requires Go v1.13 or newer. You will first need a working Go environment.
	Prerequisite: Building `kn` requires Go v1.14 or newer. You will first need a working Go environment.

Improve "Installing the Knative CLI" #2230

Improve "Installing the Knative CLI" #2230

Conversation

MIBc commented Feb 21, 2020

Proposed Changes

knative-prow-robot commented Feb 21, 2020

MIBc commented Feb 21, 2020

rhuss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

navidshaikh Feb 24, 2020 • edited Loading

Choose a reason for hiding this comment

MIBc Feb 25, 2020 • edited Loading

Choose a reason for hiding this comment

MIBc commented Mar 12, 2020

rhuss left a comment

Choose a reason for hiding this comment

rhuss commented Mar 23, 2020

evankanderson commented Apr 9, 2020

rhuss left a comment

Choose a reason for hiding this comment

rhuss commented Apr 20, 2020

matzew left a comment

Choose a reason for hiding this comment

lionelvillard commented Apr 22, 2020

MIBc commented May 18, 2020

abrennan89 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abrennan89 commented Jun 30, 2020

MIBc commented Jul 1, 2020

abrennan89 commented Jul 1, 2020

rhuss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abrennan89 commented Jul 7, 2020

knative-prow-robot commented Jul 7, 2020

navidshaikh Feb 24, 2020 •

edited

Loading

MIBc Feb 25, 2020 •

edited

Loading