Updating install flow with minor changes to reflect desired prototype in UX/11 by omerbensaadon · Pull Request #3411 · knative/docs

omerbensaadon · 2021-04-02T14:59:23Z

Changes:

Moved Kn CLI to pre-requisite
Added homebrew brew install kn command to pre-reqs
Changed flow of install from install -> Serving or Eventing to Install -> Pre-Reqs -> Serving or Eventing
Added reference to the Install files in each of the Serving and Eventing Installs
Fix broken link
Aligned any reference to "Serving" or "Eventing" to Knative Word and Phrase List

Changing link on the install page to link to pre-requisites

Added links to install either Serving or Eventing in Pre-Req

- Edited to include `kn` CLI as a pre-req - pulled out Homebrew command - bolded important portions of the page - conformed "Serving" and "Eventing" to the [Knative Word and Phrase List](https://docs.google.com/spreadsheets/d/1p1_kBUd6ZvonxHkMcEJPayf6QIpExuFf5cFq0ptar7I/edit#gid=0) - Added link to Private Registry documentation

- removed reference to KN CLI (now in Pre-Reqs) - trimmed the fat around Installing Kantive Eventing - Added relevant context to optional extensions

Added same context from Eventing Page

Added same context from Eventing Page, added (like TLS) to second bullet.

Removed reference to KN CLI (now in Pre-Reqs)

added reference to install files

Fix broken link

made wording less bad

… install out of Github and into knative.dev site (#3410) * Update install-kn.md Adding brew install kn command directly to page and making it the first option * Update docs/client/install-kn.md Co-authored-by: Mike Petersen <mpetason@gmail.com> Co-authored-by: Mike Petersen <mpetason@gmail.com>

whitespace fix

more whitespace

abrennan89

It doesn't make sense to me to add kn to the prereqs, this is an optional CLI not a prereq and it can't be used to install anything. Left some other comments too.

omerbensaadon · 2021-04-05T21:08:07Z

@abrennan89 left responses!

I think kn CLI should be a pre-req, in the sense that anyone doing anything with Knative could more easily do so through the tools we've built in our CLI.

In the future when we follow up the Install with a Tutorial, we would ideally have folks be interacting with the kn CLI and seeing where it fits into the picture.

It's a very handy piece of tech that we have an entire WG dedicated to, I think we should bubble it up more often instead of defaulting to YAML!

abrennan89 · 2021-04-05T21:26:48Z

I think kn CLI should be a pre-req, in the sense that anyone doing anything with Knative could more easily do so through the tools we've built in our CLI.

This isn't strictly true, they can't do anything with it, only certain things.

It's a very handy piece of tech that we have an entire WG dedicated to, I think we should bubble it up more often instead of defaulting to YAML!

My point is that it's not "defaulting" to YAML when we're talking about installing serving or eventing, it has to be done either via YAML or the Operator - there's no option to install components like serving or eventing using the kn CLI, so I feel like it's confusing to say people must install it when they really don't have to.

FWIW I love kn and use it for interacting with Knative in terms of creating other things, but I think putting it in install prereqs is just confusing because it's not actually required. The same way that you don't have to install both serving and eventing, we don't tell people they have to install both just because we'd like them to. The same thing IMHO should apply for kn IMHO; it's completely optional.

omerbensaadon · 2021-04-05T21:37:35Z

OK let's kick this can down the road, going to move the KN CLI out of pre-requisites

Adding `kn` CLI to Next Steps

omerbensaadon · 2021-04-05T22:30:50Z

@abrennan89 all requested changes made!

snneji · 2021-04-07T12:41:46Z

+
+- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md)
+
+- [Installing Knative Serving using YAML files](./install-serving-with-yaml.md)


Not sure it's clear from this link that this is optional.

snneji · 2021-04-07T12:42:14Z

- Install the [Knative CLI](./install-kn) to use `kn` commands.
+- [Installing Knative Eventing using YAML files](./install-eventing-with-yaml.md)
+
+- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).


Suggested change

- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).

- To add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).

snneji · 2021-04-07T12:42:43Z

- If you want to add extra features to your installation, see [Installing optional extensions](./install-extensions.md).
- If you want to install the Knative Eventing component, see [Installing Eventing using YAML files](./install-eventing-with-yaml.md)
- Install the [Knative CLI](./install-kn) to use `kn` commands.
+- [Installing Knative Eventing using YAML files](./install-eventing-with-yaml.md)


Not sure it's clear from this link that this is optional.

snneji · 2021-04-07T12:44:14Z

+
+- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).
+
+- To easily interact with Knative Services, [download the `kn` CLI](/docs/client/install-kn.md)


See my comment above on the eventing topic. I imagine the same text can be used here.

snneji · 2021-04-07T12:53:00Z

- Your Kubernetes cluster must have access to the internet, since Kubernetes needs to be able to fetch images.
+- Your Kubernetes cluster must have access to the internet, since Kubernetes needs to be able to fetch images. (To pull from a private registry, see [Deploying images from a private container registry](https://knative.dev/docs/serving/deploying/private-registry/))
+
+## Install Knative Serving and Eventing


Having this on the prerequisites topic seems confusing. It implies that installing Knative Serving and Eventing is a prerequisite.

Instead, maybe we could move the System requirements to the index page for installing Knative and remove the prerequisites topic? This new section at the bottom seems to repeat the info on the index page anyway.

omerbensaadon · 2021-04-07T14:13:47Z

@snneji how about now? :D

abrennan89

LGTM. I'll let @snneji add the lgtm label when she's done reviewing.
Thanks Omer! 🎉

abrennan89 · 2021-04-07T14:33:57Z

/approve

knative-prow-robot · 2021-04-07T14:35:06Z

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: abrennan89

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

OWNERS

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

omerbensaadon · 2021-04-07T15:06:56Z

@snneji added the "component" vs "Component" bit to Knative Word and Phrase List

accidentally left this out

abrennan89 · 2021-04-07T20:54:07Z

/retest

snneji

Just a couple more tiny tweaks. I requested changes to the other cross refs for the Knative CLI so that they match the one you applied feedback to. I'll add the LGTM label after those changes are applied. The other changes you made look good.

snneji · 2021-04-08T12:12:26Z

+
+## Next steps
+
+- To easily interact with Knative Services and Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)


Suggested change

- To easily interact with Knative Services and Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)

- To easily interact with Knative Services and Eventing components, [install the `kn` CLI](/docs/client/install-kn.md)

Is Knative Services another way to describe Knative Serving?

snneji · 2021-04-08T12:14:28Z

+
+- To add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).
+
+- To easily interact with Knative Services, [download the `kn` CLI](/docs/client/install-kn.md)


Suggested change

- To easily interact with Knative Services, [download the `kn` CLI](/docs/client/install-kn.md)

- To easily interact with Knative Services, [install the `kn` CLI](/docs/client/install-kn.md)

@snneji

* Adding @snneji changes * Adding @snneji changes round 2

omerbensaadon · 2021-04-08T13:06:50Z

That should do it? @snneji

CC: @abrennan89 I would really like to cherrypick this in 0.22 so I can test this flow 👍🏼

snneji · 2021-04-08T13:07:40Z

/lgtm

omerbensaadon · 2021-04-08T13:12:20Z

/cherrypick release-0.22

knative-prow-robot · 2021-04-08T13:13:21Z

@omerbensaadon: once the present PR merges, I will cherry-pick it on top of release-0.22 in a new PR and assign it to you.

Details

In response to this:

/cherrypick release-0.22

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/test-infra repository.

knative-prow-robot · 2021-04-08T13:16:33Z

@omerbensaadon: new pull request created: #3440

Details

In response to this:

/cherrypick release-0.22

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/test-infra repository.

Omer B added 11 commits April 2, 2021 10:02

Update _index.md

d749167

Changing link on the install page to link to pre-requisites

Update prerequisites.md

c9cf7c9

Added links to install either Serving or Eventing in Pre-Req

Update install-serving-with-yaml.md

54ff72c

- removed reference to KN CLI (now in Pre-Reqs) - trimmed the fat around Installing Kantive Eventing - Added relevant context to optional extensions

Update install-serving-with-yaml.md

833c1c4

Added same context from Eventing Page

Update install-serving-with-yaml.md

fe2316e

Added same context from Eventing Page, added (like TLS) to second bullet.

Update install-eventing-with-yaml.md

288e9fd

Removed reference to KN CLI (now in Pre-Reqs)

Update install-serving-with-yaml.md

a2124a2

added reference to install files

Update install-extensions.md

28f431f

Fix broken link

Create install-extensions.md

0cf3866

Fix broken link

Update install-eventing-with-yaml.md

fcd9212

knative-prow-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 2, 2021

google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Apr 2, 2021

Omer B and others added 4 commits April 2, 2021 11:00

Update prerequisites.md

66ad519

made wording less bad

Create prerequisites.md (#3413)

d27d3d9

whitespace fix

Update prerequisites.md (#3414)

238d8a8

more whitespace

omerbensaadon requested review from abrennan89 and snneji April 4, 2021 18:37

abrennan89 reviewed Apr 5, 2021

View reviewed changes

Comment thread docs/client/install-kn.md

abrennan89 reviewed Apr 5, 2021

View reviewed changes

Comment thread docs/install/_index.md

abrennan89 reviewed Apr 5, 2021

View reviewed changes

Comment thread docs/install/install-serving-with-yaml.md Outdated

abrennan89 reviewed Apr 5, 2021

View reviewed changes

Comment thread docs/install/prerequisites.md Outdated

abrennan89 suggested changes Apr 5, 2021

View reviewed changes

remove (like TLS)

0a402e3

Omer B added 2 commits April 5, 2021 17:53

Update install-serving-with-yaml.md (#3420)

6df9c4d

Adding `kn` CLI to Next Steps

Update install-eventing-with-yaml.md (#3421)

3a0552e

Removing kn from required (#3424)

5e68fba

snneji suggested changes Apr 7, 2021

View reviewed changes

Adding @snneji changes (#3429)

004a68c

abrennan89 approved these changes Apr 7, 2021

View reviewed changes

abrennan89 added the approved label Apr 7, 2021

Update install-serving-with-yaml.md (#3435)

e83f2af

accidentally left this out

snneji suggested changes Apr 8, 2021

View reviewed changes

Adding @snneji changes round 2 (#3439)

7f029b5

* Adding @snneji changes * Adding @snneji changes round 2

omerbensaadon added the cherrypick-0.22 label Apr 8, 2021

knative-prow-robot assigned snneji Apr 8, 2021

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 8, 2021

omerbensaadon removed the cherrypick-0.22 label Apr 8, 2021

knative-prow-robot merged commit 62150f6 into main Apr 8, 2021

knative-prow-robot mentioned this pull request Apr 8, 2021

[release-0.22] Updating install flow with minor changes to reflect desired prototype in UX/11 #3440

Merged

omerbensaadon mentioned this pull request Apr 9, 2021

Add YAML description to each of the files under "Installing Serving Component" (development/install/any-kubernetes-cluster.md) #3376

Closed

snneji mentioned this pull request Apr 9, 2021

Add YAML description to each of the files under "Installing Eventing Component" (development/install/any-kubernetes-cluster.md) #3376 #3378

Closed

evankanderson deleted the omerbensaadon-patch-7 branch April 28, 2021 19:00


		- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md)

		- [Installing Knative Serving using YAML files](./install-serving-with-yaml.md)

	- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).
	- To add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).


		- If you want to add optional enhancements to your installation, see [Installing optional extensions](./install-extensions.md).

		- To easily interact with Knative Services, [download the `kn` CLI](/docs/client/install-kn.md)


		## Next steps

		- To easily interact with Knative Services and Eventing Components, [download the `kn` CLI](/docs/client/install-kn.md)

Conversation

omerbensaadon commented Apr 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

omerbensaadon commented Apr 5, 2021

Uh oh!

abrennan89 commented Apr 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

omerbensaadon commented Apr 5, 2021

Uh oh!

omerbensaadon commented Apr 5, 2021

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

omerbensaadon commented Apr 7, 2021

Uh oh!

abrennan89 left a comment

Choose a reason for hiding this comment

Uh oh!

abrennan89 commented Apr 7, 2021

Uh oh!

knative-prow-robot commented Apr 7, 2021

Uh oh!

omerbensaadon commented Apr 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abrennan89 commented Apr 7, 2021

Uh oh!

snneji left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

omerbensaadon commented Apr 8, 2021

Uh oh!

snneji commented Apr 8, 2021

Uh oh!

omerbensaadon commented Apr 8, 2021

Uh oh!

knative-prow-robot commented Apr 8, 2021

Uh oh!

knative-prow-robot commented Apr 8, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

omerbensaadon commented Apr 2, 2021 •

edited

Loading

abrennan89 commented Apr 5, 2021 •

edited

Loading

omerbensaadon commented Apr 7, 2021 •

edited

Loading