Umbrella issue: provide a clean up explanation for every code example

[1dropaflame]

This is a Bug Report

Problem:

Code examples assume user knows how to clean up the environment after the example is done. However it is not as simple as deleting a file. One may have to reverse encryption, configs, delete deployments, services and pods.

Proposed Solution:

Every code example should have a section to clean up after itself. "Clean up".

Page to Update:

documentation pages on k8s.io

[k8s-ci-robot]

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[mengjiao-liu]

/remove-kind bug /kind feature

[Ritikaa96]

Great catch @1dropaflame , This can be an umbrella issue with all the pages mentioned. I'd be glad to contribute some of it.

[sftim]

/remove-kind bug /kind feature /retitle Umbrella issue: provide a clean up explanation for every code example

Thorough implementation will be tricky. Some things can't be definitively undone, such as a node reboot. It doesn't mean we can't try.

We might want to split this further, into explaining cleanup for tutorial pages (which I see as vital and as something that readers can reasonably expect) and for task pages (which I think is much more dependent on the specific task being explained). I'm wary of making a 400 word task page turn into a 10000 word task page that fully explains how to back up first, then test the backup, then do the task, etc.

[k8s-ci-robot]

@sftim: Those labels are not set on the issue: kind/bug

In response to [this](https://github.com/kubernetes/website/issues/39683#issuecomment-1445973179): >/remove-kind bug >/kind feature >/retitle Umbrella issue: provide a clean up explanation for every code example > >Thorough implementation will be tricky. Some things **can't** be definitively undone, such as a node reboot. It doesn't mean we can't try. > >We might want to split this further, into explaining cleanup for tutorial pages (which I see as vital and as something that readers can reasonably expect) and for task pages (which I think is much more dependent on the specific task being explained). I'm wary of making a 400 word task page turn into a 10000 word task page that fully explains how to back up first, then test the backup, then do the task, etc. > > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[Ritikaa96]

@sftim In the tutorials section, some tutorials like Learn Kubernetes Basics have interactive tutorials. Adding cleanup to them doesn't seem feasible. we can list out other pages to add cleanup here as task. what do you say?

• [ ] Configure redis using configmap
• [ ] Apply Pod Security Standards at the Cluster Level
• [ ] Apply Pod Security Standards at the Namespace Level
• [ ] Restrict a Container's Access to Resources with AppArmor
• [ ] Restrict a Container's Syscalls with seccomp
• [ ] Exposing an External IP Address to Access an Application in a Cluster
• [ ] Example: Deploying PHP Guestbook application with Redis
• [ ] StatefulSet Basics
• [ ] Example: Deploying WordPress and MySQL with Persistent Volumes
• [ ] Example: Deploying Cassandra with a StatefulSet
• [ ] Running ZooKeeper, A Distributed System Coordinator
• [ ] Connecting Applications with Services
• [ ] Using Source IP

[sftim]

We don't know what we'll do with interactive tutorials. Let's assume people will in future be following along at home - see https://kubernetes.io/blog/2023/02/14/kubernetes-katacoda-tutorials-stop-from-2023-03-31/

[Ritikaa96]

Do we need more info to accept this issue and tag triage-accepted? I guess people might start working on the cleanup info only once it is accepted.

[KhushPatibandha]

Think I can resolve this issue, I'll look into this.

[KhushPatibandha]

/assign

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[Ritikaa96]

/remove-lifecycle stale

[vaibhav2107]

@KhushPatibandha Are you still working on this issue?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[divya-mohan0209]

To all new contributors looking at this issue - we have not put a triage/accepted label on this & do not recommend you take up this issue as your first issue. /remove-lifecycle rotten

[divya-mohan0209]

@sftim : I do like the idea you have proposed & it'd be great to have it entered as the description. Although as maintainers, we can do it, @1dropaflame , please could you edit the description, if the suggestion by Tim looks good to you?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[vaibhav2107]

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale