kubernetes/minikube

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

Open

#11,571 建立於 2021年6月3日

在 GitHub 查看
 (16 留言) (0 反應) (1 負責人)Go (5,222 fork)batch import
area/testinggood first issuekind/documentationlifecycle/frozenpriority/backlog

倉庫指標

Star
 (31,799 star)
PR 合併指標
 (平均合併 12天 19小時) (30 天內合併 43 個 PR)

描述

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,

貢獻者指南