Description
/kind documentation
What happened:
I tried to figure out what the images are in test/images and why they exist. None of them had READMEs to explain this. I tried spelunking through config/jobs to reverse engineer what they are by how they are used. But it appears there is a fair amount of cargo culting happening here, where it's not entirely clear that they are used on purpose for consistent reasons.
What you expected to happen:
Find README.md files in the each of the test/image directories that quickly explained what and why these images were. Things they should and should not be used for, that sort of deal.
It would also have been neat to have an images/README.md that sort of explained why the directory exists. Does our image building tool only operate there, or does it scrape our entire repo and that just happens to be our misc/catchall dir for images that don't directly correlate to subprojects/dirs that we have in this repo?
How to reproduce it (as minimally and precisely as possible):
Try figuring out why we have the images in there that we do.
Images that need READMEs
- https://github.com/kubernetes/test-infra/tree/master/images/alpine
- https://github.com/kubernetes/test-infra/tree/master/images/alpine-bash: removed by images: remove unused images #23617
- https://github.com/kubernetes/test-infra/tree/master/images/bazel
- https://github.com/kubernetes/test-infra/tree/master/images/bazel-krte: removed by images: remove unused images #23617
- https://github.com/kubernetes/test-infra/tree/master/images/bazelbuild
- https://github.com/kubernetes/test-infra/tree/master/images/bigquery
- https://github.com/kubernetes/test-infra/tree/master/images/bootstrap (images: add or update READMEs to trigger some image builds #23555)
- https://github.com/kubernetes/test-infra/tree/master/images/builder
- https://github.com/kubernetes/test-infra/tree/master/images/cluster-api: removed by config/jobs: use community hosted images for more jobs #23587
- https://github.com/kubernetes/test-infra/tree/master/images/gcb-docker-gcloud: images: add/update READMEs to trigger image builds #23656
- https://github.com/kubernetes/test-infra/tree/master/images/gcloud (images: add or update READMEs to trigger some image builds #23555)
- https://github.com/kubernetes/test-infra/tree/master/images/gcloud-bazel
- https://github.com/kubernetes/test-infra/tree/master/images/gcloud-terraform
- https://github.com/kubernetes/test-infra/tree/master/images/git
- https://github.com/kubernetes/test-infra/tree/master/images/krte
- https://github.com/kubernetes/test-infra/tree/master/images/kubekins-e2e
- https://github.com/kubernetes/test-infra/tree/master/images/kubemci
- https://github.com/kubernetes/test-infra/tree/master/images/pull-test-infra-gubernator