knative/docs

Update Installation to better orient users

Open

#6.305 geöffnet am 29. Juli 2025

Auf GitHub ansehen
 (9 Kommentare) (0 Reaktionen) (1 zugewiesene Person)HTML (1.202 Forks)batch import
help wantedkind/documentation

Repository-Metriken

Stars
 (4.320 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 20h) (1 gemergte PR in 30 T)

Beschreibung

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:

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.

Contributor Guide