client icon indicating copy to clipboard operation
client copied to clipboard

Published 20 hours ago • verified publisher icon knative

Point installation instructions to docs site?

Open evankanderson opened this issue 3 years ago • 1 comments

Bug report

There are user install instructions (which don't include installing a release version, only nightly) at https://github.com/knative/client/blob/main/docs/README.md, as well as at https://knative.dev/docs/client/install-kn/

Expected behavior

One set of instructions which guides most users to install a released version (This caused confusion for a customer getting kn tools installed.)

evankanderson avatar Jul 30 '21 17:07 evankanderson

How about replacing contents Installing kn section in README to just a link to installation doc?

kobayashi avatar Feb 21 '22 19:02 kobayashi

Hi, I find this issue still relevant and would like to work on it. Which approach do we finally intend to go with?

  1. Update README with full instructions to install the release version.
  2. Replace the contents of 'Installing kn' subsection with the link to Installation doc on Knative website.

garg-dhruv avatar Mar 10 '23 01:03 garg-dhruv 

1. Update README with full instructions to install the release version.

Let's go with options #1. Our top-level README.md should point to knative.dev site for kn installation and customization options.

In addition I would extract docs/DEVELOPMENT.md to be also on top-level and move instructions for installing nightly builds etc.

dsimansk avatar Mar 28 '23 11:03 dsimansk

Thanks for your input. I am working on it and will try to raise a PR by today.

garg-dhruv avatar Apr 02 '23 10:04 garg-dhruv

The official website is missing channel-type-mappings configuration instructions compared to 'docs/README.md'.

Does channel-type-mappings still exist as one of the configuration options? If so, I would like to go ahead and raise a PR in knative/docs repo to amend this.

garg-dhruv avatar Apr 02 '23 22:04 garg-dhruv

The official website is missing channel-type-mappings configuration instructions compared to 'docs/README.md'.

Does channel-type-mappings still exist as one of the configuration options? If so, I would like to go ahead and raise a PR in knative/docs repo to amend this.

Yes, it still exists. I'd be really good to review the content, compare and update accordingly. Especially this page https://knative.dev/docs/client/configure-kn/.

dsimansk avatar Apr 06 '23 11:04 dsimansk