kernelci / kernelci/kernelci-pipeline
Add documentation for existing tests
- Dominant language
- Python
- Stars
- 11
- Forks
- 40
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 14
Description
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.
- [ ] Add documentation
- [ ] Deploy to `kernelci.org/docs` (https://kernelci.org/docs/tests/ looks like a good place for such information)
- [ ] Update Kernelci tests links on https://github.com/kernelci/kcidb/blob/main/tests.yaml
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with tests.yaml, the existing tests documentation at kernelci.org/docs/tests/, and the pipeline's current test definitions to inventory the tests exposed by the new API. Document each test's purpose, possible results, sub-tests, and analysis or extension guidance; done includes deploying the documentation and updating the KernelCI test links in tests.yaml.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100