Drop or adapt tutorials that rely on Katacoda #40306

sftim · 2023-03-25T18:55:58Z

Prompted by #33936

Remove pages where we don't have a replacement online, interactive tutorial mechanism, changing them to an apology message
(aside: we don't have an easy way to serve 410 Gone responses)

Update pages where we have an way to let people run the tutorial locally.

/hold
We should not make this change until the end of March 2023.

netlify · 2023-03-25T19:07:19Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`252bcf6`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6422f86beae8bf0007e0bb05
😎 Deploy Preview	https://deploy-preview-40306--kubernetes-io-main-staging.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 site settings.

divya-mohan0209

A bunch of nits. But overall, LGTM! Thank you so much for you efforts, @sftim!

content/en/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html

divya-mohan0209 · 2023-03-27T11:33:36Z

content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html

+                <h3>View the app</h3>
+                <p>Pods that are running inside Kubernetes are running on a private, isolated network.
+                By default they are visible from other pods and services within the same kubernetes cluster, but not outside that network.
+                When we use <code>kubectl</code>, we're interacting through an API endpoint to communicate with our application.</p>


I feel like we'd benefit from telling the audience here what we're interacting with, as well.

I'm trying to adapt the existing text as little as possible. Let's do that kind of tweak in a follow up PR.

content/en/docs/tutorials/kubernetes-basics/explore/explore-intro.html

divya-mohan0209 · 2023-03-27T11:37:14Z

content/en/docs/tutorials/kubernetes-basics/explore/explore-intro.html

+        <div class="row">
+            <div class="col-md-12">
+                <h3>Show the app in the terminal</h3>
+                <p>Recall that Pods are running in an isolated, private network - so we need to proxy access


Nit.

Suggested change

Recall that Pods are running in an isolated, private network - so we need to proxy access

Recall that Pods are running in an isolated, private network - so we need proxy access

“need to” feels idiomatic to me

I'm trying to adapt the existing text as little as possible. Let's do that kind of tweak in a follow up PR.

content/en/docs/tutorials/kubernetes-basics/explore/explore-intro.html

divya-mohan0209 · 2023-03-27T11:40:03Z

content/en/docs/tutorials/kubernetes-basics/explore/explore-intro.html

+                <p>Again, it's worth mentioning that the name of the container itself can be omitted since we only have a single container in the Pod.</p>
+                <p>Next let’s start a bash session in the Pod’s container:</p>
+                <p><code><b>kubectl exec -ti $POD_NAME -- bash</b></code></p>
+                <p>We have now an open console on the container where we run our NodeJS application.  The source code of the app is in the <tt>server.js</tt> file:</p>


Suggested change

We have now an open console on the container where we run our NodeJS application. The source code of the app is in the <tt>server.js</tt> file:

We have now an open console on the container where we run our NodeJS application. The source code of the app is in the <tt>server.js</tt> file:

I'm trying to adapt the existing text as little as possible. Let's do that kind of tweak in a follow up PR.

divya-mohan0209 · 2023-03-27T11:58:25Z

content/en/docs/tutorials/kubernetes-basics/expose/expose-intro.html

+				<p>Next, let’s list the current Services from our cluster:</p>
+				<p><code><b>kubectl get services</b></code></p>
+				<p>We have a Service called <tt>kubernetes</tt> that is created by default when minikube starts the cluster.
+				To create a new service and expose it to external traffic we'll use the expose command with NodePort as parameter.</p>


Suggested change

To create a new service and expose it to external traffic we'll use the expose command with NodePort as parameter.

To create a new service and expose it to external traffic we'll use the expose command with the NodePort parameter.

OR

Suggested change

To create a new service and expose it to external traffic we'll use the expose command with NodePort as parameter.

To create a new service and expose it to external traffic we'll use the expose command with NodePort as a parameter.

Neither is right.
In another PR, we could change it to:

To create a new service and expose it to external traffic we'll use the expose command, specifying NodePort as the type of Service to create.

We could also reword to avoid using we.

content/en/docs/tutorials/kubernetes-basics/expose/expose-intro.html

divya-mohan0209 · 2023-03-27T12:10:43Z

content/en/docs/tutorials/kubernetes-basics/scale/scale-intro.html

@@ -25,9 +27,10 @@ <h3>Objectives</h3>
            <div class="col-md-8">
       <h3>Scaling an application</h3>

-            <p>In the previous modules we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application.  When traffic increases, we will need to scale the application to keep up with  user demand.</p>
+            <p>Previously we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application.  When traffic increases, we will need to scale the application to keep up with user demand.</p>


nit.

Suggested change

Previously we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.

Previously we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.

sftim · 2023-03-27T20:28:21Z

I'm keen to get this approved and LGTMed (and held), so we are ready for the end of the month.

tengqm · 2023-03-28T03:24:09Z

content/en/docs/tutorials/hello-minikube.md

+{{< /tab >}}
+{{< /tabs >}}


Not sure about the change from {{% /tab %}} to {{ /tab }}.

tengqm · 2023-03-28T03:24:28Z

content/en/docs/tutorials/hello-minikube.md

@@ -287,7 +287,7 @@ kubectl delete service hello-node
 kubectl delete deployment hello-node
 ```

-Optionally, stop the Minikube virtual machine (VM):
+Stop the Minikube cluster


Suggested change

Stop the Minikube cluster

Stop the Minikube cluster:

tengqm · 2023-03-28T03:25:39Z

LGTM

content/en/docs/tutorials/hello-minikube.md

No more Katacoda. Explain that the tutorial isn't available.

No more Katacoda.

Avoid relying on Katacoda. Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>

mengjiao-liu · 2023-03-29T07:00:08Z

/lgtm

k8s-ci-robot · 2023-03-29T07:00:17Z

LGTM label has been added.

Git tree hash: 0af4fed05a2a4e2b53e987c8c7e5f8ad6c2d25ef

divya-mohan0209 · 2023-03-30T12:49:26Z

/approve

k8s-ci-robot · 2023-03-30T12:49:48Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: divya-mohan0209

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:

~~content/en/OWNERS~~ [divya-mohan0209]

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

ydFu · 2023-03-31T15:12:32Z

/label tide/merge-method-squash
/lgtm

sftim · 2023-03-31T15:51:46Z

No need to squash these commits: each represents a distinct unit of work

/remove-label tide/merge-method-squash

sftim · 2023-03-31T16:00:32Z

I reckon it's about time to ship this though.

/hold cancel

stormqueen1990 · 2023-06-06T19:07:18Z

content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html

-                <a class="btn btn-lg btn-success" href="/docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive/" role="button">Start Interactive Tutorial <span class="btn__next">›</span></a>
+                <h3>Deploy an app</h3>
+                <p>Let’s deploy our first app on Kubernetes with the <code>kubectl create deployment</code> command. We need to provide the deployment name and app image location (include the full repository url for images hosted outside Docker hub).</p>
+                <p><b><code>kubectl create deployment kubernetes-bootcamp --image=gcr.io/google-samples/kubernetes-bootcamp:v1</code></b></p>


Could these code blocks be worth formatting with a <pre> block, so they render similarly to the fenced code blocks that currently exist in Markdown pages?

Let's use a separate issue for that discussion.

@sftim I've created #41625 for this discussion.

sftim · 2023-06-12T19:21:26Z

In the end, we adapted most of these tutorials for people to run them locally.

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 25, 2023

k8s-ci-robot requested a review from divya-mohan0209 March 25, 2023 18:56

k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 25, 2023

k8s-ci-robot requested a review from mehabhalodiya March 25, 2023 18:56

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 25, 2023

divya-mohan0209 reviewed Mar 27, 2023

View reviewed changes

sftim force-pushed the 20230323_drop_katacoda branch from efdc0cd to f662efe Compare March 27, 2023 14:36

tengqm reviewed Mar 28, 2023

View reviewed changes

sftim commented Mar 28, 2023

View reviewed changes

content/en/docs/tutorials/hello-minikube.md Outdated Show resolved Hide resolved

sftim and others added 5 commits March 28, 2023 15:23

Update Hello Minikube for Katacoda EOL

5ae11de

Update ingress tutorial for Katacoda EOL

8288743

Update microservices tutorial for Katacoda EOL

46f37c3

No more Katacoda. Explain that the tutorial isn't available.

Mark Kubernetes basics tutorials missing

3e51968

No more Katacoda.

Adapt Kubernetes basics tutorials for local use

252bcf6

Avoid relying on Katacoda. Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>

sftim force-pushed the 20230323_drop_katacoda branch from d1930f1 to 252bcf6 Compare March 28, 2023 14:23

k8s-ci-robot assigned mengjiao-liu Mar 29, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 29, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 30, 2023

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 31, 2023

k8s-ci-robot assigned ydFu Mar 31, 2023

k8s-ci-robot removed the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 31, 2023

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 31, 2023

k8s-ci-robot merged commit 7b262f6 into kubernetes:main Mar 31, 2023

sftim deleted the 20230323_drop_katacoda branch March 31, 2023 16:04

This was referenced May 30, 2023

[fr] Remove outdated online interactive tutorial from Using Minikube to Create a Cluster page #41380

Closed

[pt-br] Obsolete online interactive tutorial in the Using Minikube to Create a Cluster page #41456

Closed

tamilselvan1102 mentioned this pull request Jun 5, 2023

[ja] Obsolete online interactive tutorial from the Using Minikube to Create a Cluster page #41468

Closed

dipesh-rawat mentioned this pull request Jun 5, 2023

Umbrella issue: Remove tutorials that rely on Katacoda for all localized documents #41496

Open

13 tasks

stormqueen1990 reviewed Jun 6, 2023

View reviewed changes

shurup mentioned this pull request Jul 7, 2023

[ru] Remove Katacoda tutorials and update instructions #41923

Closed

shurup mentioned this pull request Jul 14, 2023

Internal link fix for the Hello Minikube tutorial #42025

Merged

divya-mohan0209 mentioned this pull request Aug 11, 2023

Removed the link of Obsolete online interactive tutorial in the Confi… #42495

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop or adapt tutorials that rely on Katacoda #40306

Drop or adapt tutorials that rely on Katacoda #40306

sftim commented Mar 25, 2023

netlify bot commented Mar 25, 2023 •

edited

Loading

divya-mohan0209 left a comment

divya-mohan0209 Mar 27, 2023

sftim Mar 27, 2023

divya-mohan0209 Mar 27, 2023

sftim Mar 27, 2023

divya-mohan0209 Mar 27, 2023

sftim Mar 27, 2023

divya-mohan0209 Mar 27, 2023

sftim Mar 27, 2023

divya-mohan0209 Mar 27, 2023

sftim commented Mar 27, 2023

tengqm Mar 28, 2023

tengqm Mar 28, 2023

tengqm commented Mar 28, 2023

mengjiao-liu commented Mar 29, 2023

k8s-ci-robot commented Mar 29, 2023

divya-mohan0209 commented Mar 30, 2023

k8s-ci-robot commented Mar 30, 2023

ydFu commented Mar 31, 2023

sftim commented Mar 31, 2023

sftim commented Mar 31, 2023

stormqueen1990 Jun 6, 2023

sftim Jun 12, 2023

stormqueen1990 Jun 13, 2023

sftim commented Jun 12, 2023

	<p>Recall that Pods are running in an isolated, private network - so we need to proxy access
	<p>Recall that Pods are running in an isolated, private network - so we need proxy access

	<p>We have now an open console on the container where we run our NodeJS application. The source code of the app is in the <tt>server.js</tt> file:</p>
	<p>We have now an open console on the container where we run our NodeJS application. The source code of the app is in the <tt>server.js</tt> file:</p>

	To create a new service and expose it to external traffic we'll use the expose command with NodePort as parameter.</p>
	To create a new service and expose it to external traffic we'll use the expose command with the NodePort parameter.</p>

	<p>Previously we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.</p>
	<p>Previously we created a <a href="/docs/concepts/workloads/controllers/deployment/"> Deployment</a>, and then exposed it publicly via a <a href="/docs/concepts/services-networking/service/">Service</a>. The Deployment created only one Pod for running our application. When traffic increases, we will need to scale the application to keep up with user demand.</p>

Drop or adapt tutorials that rely on Katacoda #40306

Drop or adapt tutorials that rely on Katacoda #40306

Conversation

sftim commented Mar 25, 2023

netlify bot commented Mar 25, 2023 • edited Loading

✅ Pull request preview available for checking

divya-mohan0209 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Mar 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tengqm commented Mar 28, 2023

mengjiao-liu commented Mar 29, 2023

k8s-ci-robot commented Mar 29, 2023

divya-mohan0209 commented Mar 30, 2023

k8s-ci-robot commented Mar 30, 2023

ydFu commented Mar 31, 2023

sftim commented Mar 31, 2023

sftim commented Mar 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Jun 12, 2023

netlify bot commented Mar 25, 2023 •

edited

Loading