knative
Update Installation to better orient users
Overview
The installation instructions are generally very good, but there are a few speed bumps to finding and performing the right installation procedure.
Add "roadmap" information to orient readers in the Installation section of the documentation.
Audience: Admins and developers
Type: Instructional
Context
This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative.
Possible Implementation
Related material in the current doc:
- https://github.com/knative/install
Suggested changes:
On the [Installing Knative] page, provide a roadmap at the top to direct users to the correct installation. Aside from installing the different components (Eventing and Serving) using different modalities (YAML, Kubernetes Operator, and upgrading), disclose what operating systems are supported, and differentiate between local and server installations.
@evankanderson: The label(s) /label "docs" cannot be applied. These labels are supported: proposal/0.11, proposal/0.12, proposal/0.13, proposal/0.14, proposal/0.15, proposal/0.16, proposal/0.17, proposal/0.18, proposal/0.19, channel/kafka, channel/natss, source/awssqs, source/camel, source/ceph, source/couchdb, source/github, source/kafka, source/prometheus. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?
In response to this:
/label "help wanted" /label "docs"
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-sigs/prow repository.
![knative-prow[bot] avatar](https://avatars.githubusercontent.com/in/183726?v=4 "Published by a pub.dev verified publisher"){kind=small}
@evankanderson: This request has been marked as needing help from a contributor.
Please ensure the request meets the requirements listed here.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.
In response to this:
/kind documentation /help
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-sigs/prow repository.
