Installation Doc Updates #6395

iRaindrop · 2025-09-18T06:41:14Z

Improve installation guidance

iRaindrop = Bruce Hamilton bhamilton@expertsupport.com

Provide roadmap guidance for installing Knative, make improvements and consistencies.

Proposed Changes

Roadmap for installations
Improvements for accessing binaries (later push)

Improve installation guidance

netlify · 2025-09-18T06:41:19Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`84a9af2`
🔍 Latest deploy log	https://app.netlify.com/projects/knative/deploys/68d1daebace45e0008cc5fe5
😎 Deploy Preview	https://deploy-preview-6395--knative.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

evankanderson

I like the presentation. A few details to adjust:

We have 3 install options. Quickstart creates a local-only install, while you can either use YAML files or the Operator, depending on how you like to control installation on your cluster.
Install should work for all three platforms -- Mac, Windows, and Linux. We assume the target cluster is running Linux, but you can use kind/minikube locally with any platform to get a Linux Kubernetes cluster.

docs/install/README.md

link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

More writing

Misc edits

Minor edits

Consolidating CLI installations into this this topic.

Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?"

Removed alert formatting

Various edits

docs/client/install-kn.md

docs/install/README.md

Made Evan suggestions, table column test, spelling fixes

link fix

Replaced the table with a bulleted list approach.

Put back the table

Updated topics per effort - consolidating guidance

evankanderson

This is looking quite improved, thank you!

A few notes -- do you have an idea when this will be ready to merge? (In particular, do you have more content you want to add to this PR, or mostly polishing the current contents?)

docs/.nav.yml

docs/client/install-kn.md

docs/install/README.md

docs/install/quickstart-install.md

docs/install/yaml-install/eventing/install-eventing-with-yaml.md

docs/snippets/install-kn.md

iRaindrop · 2025-09-21T20:26:40Z

This is looking quite improved, thank you!

A few notes -- do you have an idea when this will be ready to merge? (In particular, do you have more content you want to add to this PR, or mostly polishing the current contents?)

Thanks Evan! Just a few more pushes to warp up this PR with the following:

Move the specific 'Install the Knative Operator CLI' section (an H2) from the 'Install Operator with CLI' topic into the 'Install CLI tools' topic.
Remove redundant prerequisite info from the Operator Install topics and point to the installation roadmap.
The 'Next steps' row is getting too busy so that will become a bulleted list with subitems.

Then in a following PR, I'll add that macro magic to get binaries more easily.

All files added for this PR.

evankanderson · 2025-09-22T22:02:38Z

I'd like to merge #6398 soon, which will conflict with this PR. I'm happy to let this PR merge first if it will be done in the next day or so -- otherwise, I may ask you to handle the merge so that I can work on backporting those changes.

iRaindrop · 2025-09-22T22:08:41Z

I'd like to merge #6398 soon, which will conflict with this PR. I'm happy to let this PR merge first if it will be done in the next day or so -- otherwise, I may ask you to handle the merge so that I can work on backporting those changes.

No problem. I'm in touch ups now and will be done within the hour.

iRaindrop · 2025-09-22T22:54:40Z

OK to merge.

evankanderson

/approve

I'd like to trim the operator stuff in the client/ section, personally, but I can understand how it got in there, since the operator subcommand is part of the kn plugin experience (as is func, which we don't mention, and a few other plugins).

docs/install/operator/knative-with-operator-cli.md

evankanderson · 2025-09-22T23:05:48Z

docs/install/quickstart-install.md

 ---

-# Install Knative using quickstart
+# Install the Knative quickstart plugin


This topic covers both installing the plugin, and using the plugin to get a cluster with Knative installed on it.

Maybe just "quickstart" or "quickstart install"?

evankanderson · 2025-09-22T23:08:33Z

docs/client/install-kn.md

+
+- Kubernetes CLI - `kubectl`
+- Knative CLI - `kn`
+- Knative Operator CLI - `kn`


The operator is part of the Knative CLI, but is primarily focused on administrators who have whole-cluster control. I think this documentation should be focused on developers, and we should leave out the operator bits.

docs/client/install-kn.md

evankanderson · 2025-09-22T23:10:57Z

docs/client/install-kn.md


 See the [Tekton documentation](http://hub.tekton.dev/tekton/task/kn){target=_blank}.
+
+## Install the Knative Operator CLI Plugin


I'm okay with leaving a note here (though it seems odd that we mention the administrator-focused operator plugin but not the developer-focused func plugin), but this section should make it clear that the operator subcommands are mostly useful for cluster administrators, rather than average developers.

Agreed. Let's find a better place for the Operator content in a subsequent PR.

knative-prow · 2025-09-22T23:11:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: evankanderson, iRaindrop

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [evankanderson]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

evankanderson · 2025-09-22T23:36:45Z

/lgtm

* Installation Doc Updates Improve installation guidance * Formatting fix * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * link fix and table update More writing * Update README.md Misc edits * Update README.md Minor edits * Adding install-kn to PR Consolidating CLI installations into this this topic. * Update install-kn.md Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?" * Update install-kn (snippet) Removed alert formatting * Added quickstart-install.md Various edits * Fixes and reviewed edits Made Evan suggestions, table column test, spelling fixes * Update quickstart-install.md link fix * Update README.md Replaced the table with a bulleted list approach. * Update README.md Put back the table * Added serving and eventing install topics Updated topics per effort - consolidating guidance * Link fixes * Made Evan's edits * Various updates All files added for this PR. * Link fix * Formatting fixes * Formatting and consistency fix * Update docs/install/operator/knative-with-operator-cli.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/client/install-kn.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> --------- Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

* Phase 1: Adding documentation metadata tags (#6274) * Add metadata tags for documentation * Add classification for about 2/3rds of docs (func + eventing) * Add classification for remainder of docs (serving+install) * Add mermaid support (#6327) * Publish threat model in documentation (#6263) * Publish threat model in documentation * Separate security contents a bit more, update link to threat model, update nav * Add a section on supply chain and SBOM/SLSA mitigation * Update threat model with feedback from David Hadas * Update introduction with content from davidhadas, add sections on controller and webhook functionality and update targets of threats * content tab fixes, added success output for kn func (#6367) * Add dry run section and take out old feature flag in serving (#6366) * add dry run section * drop mention of old feature flag * fix casing on nav * update docs to be more clear and include inline example --------- Co-authored-by: Dave Protasowski <dprotaso@gmail.com> * Attempt to rebuild docs build process, inspired by #6319 (#6371) * Attempt to rebuild docs build process * Use a more modern python version * Fix strict verify, hide versions on unversioned pages * Fix search with mkdocs typescript patches (vendored). (#6392) Hopefully, this can be fixed upstream via PR shortly. * Installation Doc Updates (#6395) * Installation Doc Updates Improve installation guidance * Formatting fix * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/install/README.md link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * link fix and table update More writing * Update README.md Misc edits * Update README.md Minor edits * Adding install-kn to PR Consolidating CLI installations into this this topic. * Update install-kn.md Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?" * Update install-kn (snippet) Removed alert formatting * Added quickstart-install.md Various edits * Fixes and reviewed edits Made Evan suggestions, table column test, spelling fixes * Update quickstart-install.md link fix * Update README.md Replaced the table with a bulleted list approach. * Update README.md Put back the table * Added serving and eventing install topics Updated topics per effort - consolidating guidance * Link fixes * Made Evan's edits * Various updates All files added for this PR. * Link fix * Formatting fixes * Formatting and consistency fix * Update docs/install/operator/knative-with-operator-cli.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Update docs/client/install-kn.md Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> --------- Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com> * Fix edit page links, move technical docs under sub-heading (#6398) * Fix edit links by moving docs content under a dedicated subdirectory * Fix edit links by moving docs content under a dedicated subdirectory * Add High availability documentation section for eventing (#6401) I have copy-pasted from the Knative Serving documentation page the block as I found it missing when configuring it. * Update proc-running-function.md (#6400) Undo separeate kn func output for invoke * Add a note that Apache Kafka is required to use EKB (#6404) * Move install docs to administration (#6403) * Fix trailing newline complaints * Fix redirects from #6398 --------- Co-authored-by: Bruce Hamilton <scarlettbernique@gmail.com> Co-authored-by: Alexander-Kita <Alexander.Kita@ibm.com> Co-authored-by: Dave Protasowski <dprotaso@gmail.com> Co-authored-by: Aurélien Joga <aurelienjoga+ajoga@gmail.com> Co-authored-by: Christoph Stäbler <cstabler@redhat.com>

Installation Doc Updates

20ff9df

Improve installation guidance

knative-prow bot requested review from matzew and skonto September 18, 2025 06:41

knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 18, 2025

iRaindrop marked this pull request as draft September 18, 2025 06:41

knative-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 18, 2025

Formatting fix

d9d3690

evankanderson reviewed Sep 18, 2025

View reviewed changes

iRaindrop and others added 9 commits September 18, 2025 12:47

Update docs/install/README.md

6ffb330

link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

Update docs/install/README.md

86bd901

link fix Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

link fix and table update

1600db8

More writing

Update README.md

c966d84

Misc edits

Update README.md

8d0e25e

Minor edits

Adding install-kn to PR

1a28179

Consolidating CLI installations into this this topic.

Update install-kn.md

5ffbfd3

Changing red bug alert to important The old syntax was: ??? bug "Having issues upgrading `kn` to Homebrew?"

Update install-kn (snippet)

14604c7

Removed alert formatting

Added quickstart-install.md

7afcf68

Various edits

evankanderson reviewed Sep 20, 2025

View reviewed changes

iRaindrop added 3 commits September 19, 2025 19:18

Fixes and reviewed edits

3c4cfc0

Made Evan suggestions, table column test, spelling fixes

Update quickstart-install.md

0d5c3a6

link fix

Update README.md

aa51212

Replaced the table with a bulleted list approach.

knative-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 20, 2025

Update README.md

62eb22f

Put back the table

knative-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 20, 2025

Added serving and eventing install topics

b026363

Updated topics per effort - consolidating guidance

knative-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 21, 2025

Link fixes

c6182f2

evankanderson reviewed Sep 21, 2025

View reviewed changes

Made Evan's edits

1156da3

iRaindrop added 2 commits September 22, 2025 14:16

Various updates

7ab0d5d

All files added for this PR.

Link fix

e7ee630

iRaindrop added 2 commits September 22, 2025 15:28

Formatting fixes

c8025f7

Formatting and consistency fix

92f6808

iRaindrop marked this pull request as ready for review September 22, 2025 22:53

knative-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 22, 2025

knative-prow bot requested review from mmejia02 and pierDipi September 22, 2025 22:53

evankanderson reviewed Sep 22, 2025

View reviewed changes

knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 22, 2025

iRaindrop and others added 2 commits September 22, 2025 16:22

Update docs/install/operator/knative-with-operator-cli.md

0ed91d6

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

Update docs/client/install-kn.md

84a9af2

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

knative-prow bot assigned evankanderson Sep 22, 2025

knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Sep 22, 2025

knative-prow bot merged commit 554d71d into knative:main Sep 22, 2025
18 of 19 checks passed

iRaindrop deleted the bh_install-updates branch September 22, 2025 23:54

evankanderson mentioned this pull request Sep 25, 2025

Cherry pick about 13 PRs into release-1.19 #6405

Merged


		See the [Tekton documentation](http://hub.tekton.dev/tekton/task/kn){target=_blank}.

		## Install the Knative Operator CLI Plugin

Installation Doc Updates #6395

Installation Doc Updates #6395

Uh oh!

Conversation

iRaindrop commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Uh oh!

netlify bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for knative ready!

Uh oh!

evankanderson left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evankanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iRaindrop commented Sep 21, 2025

Uh oh!

evankanderson commented Sep 22, 2025

Uh oh!

iRaindrop commented Sep 22, 2025

Uh oh!

iRaindrop commented Sep 22, 2025

Uh oh!

evankanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

evankanderson Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

evankanderson Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

evankanderson Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

iRaindrop Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

knative-prow bot commented Sep 22, 2025

Uh oh!

evankanderson commented Sep 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

iRaindrop commented Sep 18, 2025 •

edited

Loading

netlify bot commented Sep 18, 2025 •

edited

Loading

evankanderson left a comment •

edited

Loading