knative/docs

Update Installation to better orient users

Open

#6,305 opened on Jul 29, 2025

View on GitHub
 (9 comments) (0 reactions) (1 assignee)HTML (1,202 forks)batch import
help wantedkind/documentation

Repository metrics

Stars
 (4,320 stars)
PR merge metrics
 (Avg merge 4d 20h) (1 merged PR in 30d)

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.

Contributor guide

Research direction
Add a roadmap section at the top of the installation page to orient users, listing supported operating systems and differentiating between local and server installations.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85