Skip to content

Improve context for each of the steps of the YAML-based install  #26

@omerbensaadon

Description

@omerbensaadon

What is changing? (Please include as many details as possible.)

Currently, the steps in the YAML-based install are devoid of context. Examples below:

  1. Screen Shot 2021-03-21 at 9 55 26 PM
  2. Screen Shot 2021-03-21 at 9 55 43 PM

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    EpicEpics to group issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions