Add guidelines to write good conformance tests for k8s #221
Conversation
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
There was a problem hiding this comment.
Thanks for drafting this! I think we should address whatever Markdownlint says. Apart from that, I would ask you to be more brief and to the point. I suggest to use simple sentences, such as "First, we check whether all requirements of the development environment are met" (instead of "this can be used to") or "Next, we start the development Kind cluster" (instead of "Once ..., you can ..."). This kind of holding-hands step-by-step guide is appropriate, but I think we should also have a brief(!) descriptive overview as well. For instance, explain the structure of the test directory, the components that are involved in testing etc.
| --- | ||
| title: SCS Conformance Test KaaS Sonobuoy | ||
| type: | ||
| status: Draft | ||
| track: Global | ||
| --- |
There was a problem hiding this comment.
I know the other files in this directory have a front matter, but I don't think that we are actually using it in the docs pages. It can be dropped, and it should be dropped, because it could confuse people.
| status: Draft | ||
| track: Global | ||
| --- | ||
|
|
There was a problem hiding this comment.
This document has a lot of Markdown errors. Please fix whatever the linter reports on.
| > A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record]. | ||
| > In addition, sonobuoy is also used as the toolset for executing Kubernetes very own [conformance tests][k8s-conformance]. |
There was a problem hiding this comment.
This is not a quote! (Same for the other "quotes" below.)
contributor-docs/development/tests/conformance-tests-sonobuoy.md
Outdated
Show resolved
Hide resolved
contributor-docs/development/tests/conformance-tests-sonobuoy.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Toni Finger <[email protected]>
Signed-off-by: Toni Finger <[email protected]>
This PR contains guidelines and best practices on how to write good conformance tests for K8S by using Sonobuoy.