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.

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

Add banner to highlight dockershim migration docs #30837

Closed
sftim opened this issue Dec 9, 2021 · 22 comments
Closed

Add banner to highlight dockershim migration docs #30837

sftim opened this issue Dec 9, 2021 · 22 comments
Assignees
Labels
committee/steering Denotes an issue or PR intended to be handled by the steering committee. kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/node Categorizes an issue or PR as relevant to SIG Node.

Comments

@sftim
Copy link
Contributor

sftim commented Dec 9, 2021

This is a Feature Request

What would you like to be added
When there are good / good-enough docs for migration away from dockershim, add a banner that highlights these docs. Leave that banner in place until (maybe even after) the v1.24 release.

Why is this needed
We're removing dockershim from Kubernetes

Comments
/sig node
/kind feature

Will need steering committee signoff

@sftim sftim added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 9, 2021
@k8s-ci-robot k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 9, 2021
@k8s-ci-robot
Copy link
Contributor

@sftim: 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@reylejano
Copy link
Member

/committee steering

@k8s-ci-robot k8s-ci-robot added the committee/steering Denotes an issue or PR intended to be handled by the steering committee. label Feb 8, 2022
@reylejano
Copy link
Member

Hi @kubernetes/steering-committee , just want to put this on your radar

@chris-short
Copy link
Contributor

@sftim What's the right way to do this on the site? Is there any existing shortcode/partial for doing this? Please tag in anyone you might know that has the answer.

@reylejano
Copy link
Member

reylejano commented Feb 15, 2022

@chris-short here's the PR that added a banner for KubeCon Europe 2021
#27844
and here's the PR for a banner for KubeCon NA 2021 and announcement for KubeCon China
#29192

@liggitt
Copy link
Member

liggitt commented Feb 15, 2022

is a months-long site-wide banner appropriate for this?

@sftim
Copy link
Contributor Author

sftim commented Feb 15, 2022

months-long

I hadn't imagined that the banner would be shown for months. It might be ready for over a month though. I suppose I started off pessimistic that the relevant docs would be ready well before the next release.

We could

  • add the banner with timings so that it's in place for a short time around the release - perhaps 3 days before the release and 7 days afterwards
  • have a PR ready to add a banner, and hold that PR pending a problematic social media reaction (unholding if we think it becomes important to direct all readers to our key page on the topic)

@sftim
Copy link
Contributor Author

sftim commented Feb 15, 2022

We don't have a mechanism to mark banners as seen. Maybe it'd be useful to add one.

@chris-short
Copy link
Contributor

Okay, so not a sitewide banner for months, check.

What should the banner say? Where should it link?

Found this in #31425, applicable here? 

Warning: This page mentions Docker Engine. Docker Engine compatibility was deprecated as of Kubernetes 1.24. For more information see [Dockershim FAQ](https://kubernetes.io/blog/2020/12/02/dockershim-faq/)

@sftim
Copy link
Contributor Author

sftim commented Feb 15, 2022

@chris-short what #31425 suggests a notice for specific pages.

This is about adding a banner (see #23183 for an example) that shows across every page of the site, during a defined period.

We might want to do either or both. This suggestion, the site-wide banner, is not yet triaged as accepted.

@sftim
Copy link
Contributor Author

sftim commented Feb 15, 2022

I'm thinking we might say “Want to know more about changes in Kubernetes v1.24 around integration with Docker Engine? Visit xxxx”. Something like that.

@chris-short
Copy link
Contributor

chris-short commented Feb 15, 2022

Yes, I am good with the schedule and mechanics of making that happen.

I was more interested in the message itself. I still think the dockershim FAQ might be the best to send folks despite it having an outdated info warning on it now. Can we turn that off for that page?!?

@chrisnegus
Copy link
Contributor

@chris-short It looks like someone just put out an update of the blog: https://kubernetes.io/blog/2022/02/17/dockershim-faq/

@chris-short
Copy link
Contributor

That was me

@chrisnegus
Copy link
Contributor

Since I took on Issue #31425 I can work on this one as well.
/assign

@chrisnegus
Copy link
Contributor

chrisnegus commented Apr 7, 2022

I added PR #32805 to address this issue. I'm looking for feedback on wording, graphics and timeframe.

@chrisnegus
Copy link
Contributor

PR #32805 merged
/close

@k8s-ci-robot
Copy link
Contributor

@chrisnegus: Closing this issue.

In response to this:

PR #32805 merged
/close

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.

@sftim
Copy link
Contributor Author

sftim commented Apr 16, 2022

/reopen

We should prepare a banner update to go live on release day.

@k8s-ci-robot
Copy link
Contributor

@sftim: Reopened this issue.

In response to this:

/reopen

We should prepare a banner update to go live on release day.

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.

@k8s-ci-robot k8s-ci-robot reopened this Apr 16, 2022
@sftim
Copy link
Contributor Author

sftim commented May 8, 2022

Done
/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue.

In response to this:

Done
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
committee/steering Denotes an issue or PR intended to be handled by the steering committee. kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/node Categorizes an issue or PR as relevant to SIG Node.
Projects
None yet
Development

No branches or pull requests

6 participants