You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Pipeline is running a range of tests with the new API.
Add documentation explaining each of them in detail to make sure new users or developers can understand details such as what the test is about, possible test results, sub-tests, and can use this information for test analysis, post-processing, or even adding new tests.
Just to clarify, is this about documenting how each tests behave and their results? What is the purpose of this? and how would we scale it once we have hundreds of tests?
JenySadadia
changed the title
Add documentation for tests
Add documentation for existing tests
Apr 27, 2024
Just to clarify, is this about documenting how each tests behave and their results? What is the purpose of this?
The purpose is to add existing test suites' summary. Maybe we can omit the test results but summarize what the test is about. Something like what we currently have for legacy system i.e. https://kernelci.org/docs/tests/.
how would we scale it once we have hundreds of tests?
Yes, I agree that it's difficult to maintain this kind of doc. However, I believe it's important for KernelCI users/developers to be aware of different kinds of tests that the KernelCI is capable of running.
This data is also useful for tools that will analyze/interpret test results for post-processing. For instance, database service such as KCIDB.
Pipeline is running a range of tests with the new API.
Add documentation explaining each of them in detail to make sure new users or developers can understand details such as what the test is about, possible test results, sub-tests, and can use this information for test analysis, post-processing, or even adding new tests.
kernelci.org/docs
(https://kernelci.org/docs/tests/ looks like a good place for such information)The text was updated successfully, but these errors were encountered: