Add test failure troubleshooting docs #3528
Conversation
| @@ -0,0 +1,116 @@ | |||
| Troubleshoot Test Failures | |||
There was a problem hiding this comment.
Please merge understand_results page into this one. It doesn't need a separated page to explain test status.
There was a problem hiding this comment.
docs/img/serial_console_logs.png
Outdated
There was a problem hiding this comment.
This screenshot is from azure storage, not in upstream lisa. Please use a screen shot from the upstream lisa.
| Overview | ||
| -------- | ||
|
|
||
| To understand a test failure, the recommended troubleshooting path is: |
There was a problem hiding this comment.
Please explain more on why we recommend this. Because the test results should be able to troubleshoot most issues, and it's simple to read and get.
|
|
||
| - `Overview <#overview>`__ | ||
| - `Test results <#test-results>`__ | ||
| - `Console output <#console-output>`__ |
There was a problem hiding this comment.
The sections should follow what we recommended in the Overview. Like the "Error Message" section, it explains the test results, and where the error message can be found, and so on.
| - `Overview <#overview>`__ | ||
| - `Test results <#test-results>`__ | ||
| - `Console output <#console-output>`__ | ||
| - `Log Folder Structure <#log-folder-structure>`__ |
There was a problem hiding this comment.
Log folder structure should be a sub-topic of Log files.
This adds information for LISA users on how to troubleshoot test failures and how to understand the console output and logs.
Thank you for Lili Deng and Chi Song who created the images and provided information to make this documentation.