kubernetes/minikube

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

Open

#11,571 opened on Jun 3, 2021

View on GitHub
 (16 comments) (0 reactions) (1 assignee)Go (5,222 forks)batch import
area/testinggood first issuekind/documentationlifecycle/frozenpriority/backlog

Repository metrics

Stars
 (31,799 stars)
PR merge metrics
 (Avg merge 12d 19h) (43 merged PRs in 30d)

Description

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,

Contributor guide

Research direction
Examine the test files under test/integration/ and the documentation generation code in Makefile or scripts that produce the page. Look at existing comments on test functions and update them to describe the exact steps, test data, and any special cases as shown in the issue example.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80