Skip to content

add detailed info about what each integration test is doing to the site #11571

@medyagh

Description

@medyagh

currently our make generate-docs creates this page

https://minikube.sigs.k8s.io/docs/contrib/tests/

which generates the site based on the Comments on the Test and validate the func,

I would like these descriptions to exaclty say what it is doing instead of a general text

validateBuildImage 
makes sures that minikube image build works as expected


it should say

validateBuildImage makes sures that `minikube image build` works as expected
 builds an image using `minikube image build` and 
 the Dockerfile located in test/integration/testdata/build/Dockerfile 
 which adds a relative file into a busybox container
 and then ensures the image was build using image inspect inside minikbue 
 special case :
 in case of contained it starts the buildkit inside minikube
 currently skipped on None Driver and Github Actions on MacOs,

Metadata

Metadata

Labels

area/testinggood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.priority/backlogHigher priority than priority/awaiting-more-evidence.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions