-
Notifications
You must be signed in to change notification settings - Fork 14.9k
Update /docs/tutorials/hello-minikube image from echoserver to agnhost #51364
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
base: main
Are you sure you want to change the base?
Update /docs/tutorials/hello-minikube image from echoserver to agnhost #51364
Conversation
Welcome @bourgeoisor! |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bourgeoisor Thanks for your contribution. It appears that this PR includes changes to files across multiple languages (English, Bengali, German, Hindi, Italian etc). However, docs follows different processes for each localization, and we typically don't accept pull requests that impact multiple languages simultaneously. I would recommend modify only the primary website content (which means only English content) initially with this PR. Localization updates can be addressed separately after merge of English content.
Explicit hold until this PR only covers one language. |
@dipesh-rawat to clarify, this same one-line bug fix across 9 localizations requires nine (9) individual 1-line PRs? If so, I can definitely do that if that's what's required, but it's going to take a little bit. I understand that this is the process in place, but thinking about it from the lens of me being a first-time contributor, my first two thoughts are:
Not intentionally trying to go against the status quo (I'm a first time contributor, after all), but are we sure this process doesn't alienate potential contributions, at the expense of docs quality? In this particular case, this bug was fixed in /en/ in 2022 but has remained buggy in all localizations ever since, perhaps because the initial contributor didn't want to, didn't have time to, or simply forgot, to create the additional 8 PRs to port the line-change to localizations. |
Does the rule about one localization per PR apply when the string that's being changed isn't actually localized content? It's the image path in a kubectl command, so it's verbatim across the localized files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bourgeoisor!
LGTM - non-localized image path
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: apeabody The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we move this out to be stored in a data file or param / referenced by a shortcut so future updates can be replicated across source files?
We avoid breaking changes to this image, but eventually having an old unpatched version in the docs won't be great ... it would probably be easier to keep up to date if we could centrally approve a new version and verbatim auto-include it in the relevant examples.
My suggestion as a maintainer of this image but NOT of kubernetes/website 😅
I'll defer to @dipesh-rawat (does |
Absolutely re: defer. This just reminded me to raise it 😅 From a technical perspective, the commit I linked is using the same tooling (hugo), it's definitely possible. |
@dipesh-rawat there seems to be potential for exceptions in the one-PR-per-language guideline when changes are purely mechanical and identical (like in this PR). For instance in #51398. Can you confirm whether my PR still needs to be split in nine (9) separate one-line PRs? |
Description
In 2022, the image used for the hello-minikube tutorial was updated from
k8s.gcr.io/echoserver
toregistry.k8s.io/e2e-test-images/agnhost
since the latter was multi-platform and had generally less compatibility issues (see #37383 for details and reasoning). The localization pages, though, had never been updated, and so to this day are not compatible with all platforms (see linked bug below).This PR updates the image on all localizations to be in-line with
/en/
. I've also taken the liberty to bump/en/
from:1.39
to latest (1.53
) (see https://hub.docker.com/r/opsdockerimage/e2e-test-images-agnhost/tags).Testing
Tested the new release on ARM64, it still works as it did in
1.39
:Issue
Closes: #51324