knative/docs

Update Installation to better orient users

Open

#6 305 ouverte le 29 juil. 2025

Voir sur GitHub
 (9 commentaires) (0 réactions) (1 assigné)HTML (1 202 forks)batch import
help wantedkind/documentation

Métriques du dépôt

Stars
 (4 320 stars)
Métriques de merge PR
 (Merge moyen 4j 20h) (1 PR mergée en 30 j)

Description

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.

Guide contributeur