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

kubernetes / minikube

Run Kubernetes locally

https://minikube.sigs.k8s.io/

Apache License 2.0

29.21k stars 4.87k forks source link

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

Open medyagh opened 3 years ago

medyagh commented 3 years ago

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,

dinever commented 3 years ago

/assign

jayesh-srivastava commented 3 years ago

Hey, I am a beginner and I would like to work on this issue. Can you please explain a bit further and assign it to me. That would be great.

KShivendu commented 3 years ago

/assign

KShivendu commented 3 years ago

Hi @dinever It has been a while since you commented on the task. If you're busy, can you please assign the task to me?

k8s-triage-robot commented 2 years ago

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot commented 2 years ago

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

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

/lifecycle rotten

spowelljr commented 2 years ago

Hi @KShivendu, are you still working on this issue?

KShivendu commented 2 years ago

Hi @spowelljr, thanks for reaching out. I might not be able to finish this task anytime soon because of some other commitments. Please assign it to yourself if you're interested :)

spowelljr commented 2 years ago

No worries, thanks for unassigning yourself!

rakavai commented 2 years ago

/assign

vijaya-lakshmi-venkatraman commented 2 years ago

Hi, Is validateBuildImage still a part of the tests in the provided link? I could not find it in the page - https://minikube.sigs.k8s.io/docs/contrib/tests/

BeElectronicSakshi commented 1 week ago

Hi Team, Can team confirm whether the issue is still open?

BeElectronicSakshi commented 1 week ago

/assign