Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add warning about Katacoda shutdown #34005

Merged
merged 2 commits into from
May 31, 2022
Merged

Add warning about Katacoda shutdown #34005

merged 2 commits into from
May 31, 2022

Conversation

sftim
Copy link
Contributor

@sftim sftim commented May 28, 2022 •
edited
Loading

Fixes #34004

Add a warning about the shutdown of Katacoda (see #33936 and #33918).

Example

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 28, 2022
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label May 28, 2022
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label May 28, 2022
@sftim
Copy link
Contributor Author

sftim commented May 28, 2022

@tengqm - you're this week's PR wrangler and @bradtopol - you're up from tomorrow - could I ask you to move this one forward if you get time?

@netlify
Copy link

netlify bot commented May 28, 2022 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit a7c5ec8
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/629372b5d61cf70008711085
😎 Deploy Preview https://deploy-preview-34005--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@marcosnils marcosnils mentioned this pull request May 28, 2022
Closed
tengqm
tengqm reviewed May 29, 2022
View reviewed changes
layouts/docs/baseof.html Outdated
@@ -24,6 +24,11 @@
{{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }}
{{ block "deprecated" . }}
{{ partial "deprecation-warning.html" . }}
{{ end }}
{{ if .HasShortcode "kat-button" }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how to make the condition more generic. For example, page 'https://deploy-preview-34005--kubernetes-io-main-staging.netlify.app/docs/tutorials/kubernetes-basics/explore/explore-interactive/' doesn't have such a warning.

A more straightforward approach would be add this warning to those pages directly, and then remove the whole page completely when the day comes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a new shortcode to those pages. We can now detect all Katacoda use for the English localization, and updating other localizations is only a search-and-replace away.

sftim added 2 commits May 29, 2022 14:07
@sftim
Add warning about Katacoda shutdown
e173bf4
@sftim
Extend Katacoda removal warning
a7c5ec8 
Also cover HTML-based interactive tutorials that do not launch Katacoda
from a button. This commit only updates the English localization.
@sftim sftim force-pushed the 20220528_warn_katacoda_removal branch from dff7e4d to a7c5ec8 Compare May 29, 2022 13:18
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 29, 2022
@tengqm
Copy link
Contributor

tengqm commented May 30, 2022

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 30, 2022
@reylejano
Copy link
Member

More example pages:

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 31, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: e451ab0800b31f38c9057b620464e96a5a963728

@k8s-ci-robot k8s-ci-robot merged commit 7eb8181 into kubernetes:main May 31, 2022
@mtardy
Copy link
Member

mtardy commented May 31, 2022 •
edited
Loading

/lgtm
Aside I just noticed that the CSS is messed up on these Katacoda tutorial pages like this one https://kubernetes.io/docs/tutorials/kubernetes-basics/explore/explore-interactive/.

It's not related to this PR, but it's obvious with the new warning box:
https://deploy-preview-34005--kubernetes-io-main-staging.netlify.app/docs/tutorials/hello-minikube/
https://deploy-preview-34005--kubernetes-io-main-staging.netlify.app/docs/tutorials/kubernetes-basics/explore/explore-interactive/

edit: I got raced 🏎🙃

@sftim sftim deleted the 20220528_warn_katacoda_removal branch August 27, 2022 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sea-n Sea-n Sea-n left review comments

@tengqm tengqm tengqm left review comments

@mehabhalodiya mehabhalodiya Awaiting requested review from mehabhalodiya

@shannonxtreme shannonxtreme Awaiting requested review from shannonxtreme

Assignees

@reylejano reylejano

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Warn about Katacode shutdown
7 participants
@sftim @tengqm @k8s-ci-robot @reylejano @mtardy @Sea-n @senthilv17