Website: Issue with k8s.io/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro/

[lukos]

This is a Bug Report

Problem
The section "Deploying your first app on Kubernetes" is unclear. It starts talking about "For our first Deployment, we'll use a Node.js application packaged in a Docker container..." and then directs the user to a separate tutorial but then continues with, "Now that you know what Deployments are, let's go to the online tutorial and deploy our first app!"

Are we supposed to run a tutorial to deploy something and then run the interactive tutorial to deploy something? Is the linked Hello Minikube example only if you are not using the interactive tutorial?

Proposed Solution:
Reword or remove the reference to the external example, it should be much clearer if the Hello Minikube is a required step, an FYI or whether it is not needed any more and removed instead.

Page to Update:
https://kubernetes.io/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro/

[sftim]

That's a good point @lukos

For our first Deployment, we'll use a Node.js application packaged in a Docker container. To create the Node.js application and deploy the Docker container, follow the instructions from the Hello Minikube tutorial.

is the misleading text, right?

/language en

An aside: the style guide recommends addressing the reader as “you”. Might be worth bearing that in mind when rewording.

[lukos]

Yes, that's the part.

[tddorgtfo]

The way the page reads it seems the reader is creating their "first deployment" twice. I have submitted a PR to remove the paragraph, as it is unnecessary.

[poothia]

@lukos @sftim @tddorgtfo Maybe we can re-word its something like this, rather than removing it altogther, so user understands that there is no need to follow the links but if needed they know where to find the link to deploy it in their local env.

For our first Deployment, we'll use a Node.js application packaged in a Docker container. To create the Node.js application and deploy the Docker container, follow the instructions from the Hello Minikube tutorial.

to

For our first Deployment, we'll use a Node.js application packaged in a Docker container. To create the Node.js application and deploy the Docker container in your local environment you can follow the instructions from the Hello Minikube tutorial.

[lukos]

I think it would be clearer to do what @poothia says but with the wording:

"...If you want to create the Node.js application...." and not "...To create the Node.js application" which is passive and less clear.

[sftim]

How about

For your first Deployment, you'll use a Node.js application packaged in a Docker container. (If you didn't already try creating a Node.js application and deploying it using a container, you can do that first by following the instructions from the Hello Minikube tutorial).

?

(Using 2nd person as per address the reader as “you” from the style guide)

[poothia]

@sftim agreed... this should be the desired change.

[tddorgtfo]

PR Revised as per above. @sftim @poothia

[poothia]

I think this issue can be closed.