What is changing? (Please include as many details as possible.)
Currently, the steps in the YAML-based install are devoid of context. Examples below:
-
-
Ideally, each of these sections would have a bit of information about what you are doing to your cluster and why you may want to follow that step in the installation process.
Context
During the "Getting Started" interviews, we heard from many users that the installation process for Knative was frustrating.
Networking, for example, was a massive friction point for many users. Many did not understand which networking layer they ought to use and our defaulting to Istio was a nudge to folks that we were "recommending" it as the default networking layer.
We also heard comments to the effect of "I did the install but I had no idea what I did" which is a smell that we may be giving people a bunch of terminal commands without sufficient context.
How will this impact Knative users?
Adding more context to the different steps in the installation will help make more users successful.
Prototype
Each of the subheadings on https://knative.dev/development/install/any-kubernetes-cluster/ ought to have additional context associated with them as well as links out to explanatory docs if they exist.
More specific prototypes to be attached to child issues.
Potential Feature List
What is changing? (Please include as many details as possible.)
Currently, the steps in the YAML-based install are devoid of context. Examples below:
Ideally, each of these sections would have a bit of information about what you are doing to your cluster and why you may want to follow that step in the installation process.
Context
During the "Getting Started" interviews, we heard from many users that the installation process for Knative was frustrating.
Networking, for example, was a massive friction point for many users. Many did not understand which networking layer they ought to use and our defaulting to Istio was a nudge to folks that we were "recommending" it as the default networking layer.
We also heard comments to the effect of "I did the install but I had no idea what I did" which is a smell that we may be giving people a bunch of terminal commands without sufficient context.
How will this impact Knative users?
Adding more context to the different steps in the installation will help make more users successful.
Prototype
Each of the subheadings on https://knative.dev/development/install/any-kubernetes-cluster/ ought to have additional context associated with them as well as links out to explanatory docs if they exist.
More specific prototypes to be attached to child issues.
Potential Feature List
^^ See Add YAML description to each of the files under "Installing Serving Component" (development/install/any-kubernetes-cluster.md) docs#3376 ^^
^^ See Add context as to why users need to add a Networking layer, add a recommendation for prototyping (development/install/any-kubernetes-cluster.md) docs#3377 ^^
^^ See Add YAML description to each of the files under "Installing Eventing Component" (development/install/any-kubernetes-cluster.md) #3376 docs#3378 ^^