Skip to content
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

Point installation instructions to docs site? #1410

Closed
evankanderson opened this issue Jul 30, 2021 · 6 comments · Fixed by #1799
Closed

Point installation instructions to docs site? #1410

evankanderson opened this issue Jul 30, 2021 · 6 comments · Fixed by #1799
Labels
good first issue Denotes an issue ready for a new contributor. kind/bug Categorizes issue or PR as related to a bug. triage/accepted Issues which should be fixed (post-triage)
Milestone

Comments

@evankanderson
Copy link
Member

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 evankanderson added the kind/bug Categorizes issue or PR as related to a bug. label Jul 30, 2021
@dsimansk dsimansk added the triage/accepted Issues which should be fixed (post-triage) label Aug 16, 2021
@rhuss rhuss added the good first issue Denotes an issue ready for a new contributor. label Jan 25, 2022
@rhuss rhuss moved this to Icebox in Client Planning Jan 25, 2022
@rhuss rhuss moved this from Icebox to In Design in Client Planning Jan 25, 2022
@rhuss rhuss added this to the 1.3 (0.29) milestone Jan 25, 2022
@kobayashi
Copy link
Contributor

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

@rhuss rhuss modified the milestones: 1.3 (0.30), 1.5 (0.32) Apr 19, 2022
@garg-dhruv
Copy link
Contributor

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.

@dsimansk
Copy link
Contributor

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.

@garg-dhruv
Copy link
Contributor

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

@garg-dhruv
Copy link
Contributor

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.

@dsimansk
Copy link
Contributor

dsimansk commented Apr 6, 2023

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/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor. kind/bug Categorizes issue or PR as related to a bug. triage/accepted Issues which should be fixed (post-triage)
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants