search

cta-wave / device-observation-framework

This repository contains the WAVE Device Observation Framework. The DPCTF Device Observation Framework determines pass or fail results, based on observations taken of tests which are run on a device by the DPCTF Test Runner. DPCTF is the Device Playback Compatibility Task Force of the CTA WAVE Project (https://CTA.tech/WAVE and standards@CTA.tech for more info).
Other
1 stars 3 forks source link

Linking additional documentation on debugging observation failures when failures are encountered #66

Closed gitwjr closed 9 months ago

gitwjr commented 11 months ago

A separate document https://github.com/cta-wave/device-observation-framework/wiki/Debugging-Observation-Failures) is required to describe how to debug observation failures. see Issue #51. It would be useful to include a link to the document when such failures occur to guide the test engineer. A discussion as to how this can be done is needed. This issue is deferred to the next release

jpiesing commented 9 months ago

I'm unclear where it is proposed to include the link to the additional document on debugging. Is it proposed to put it in the OF readme? In the QUICKSTART? A one line entry in QUICKSTART may be most appropriate.

gitwjr commented 9 months ago

I agree QuickStart is needed since that is where they will be working from. There are also helpful hints on the windows_wsl.md page which would be useful in QS. https://github.com/cta-wave/dpctf-deploy/blob/master/WINDOWS_WSL.md

It might be helpful for troubleshooting/hints (oro links) on the README page and the OF Guide.

yanj-github commented 9 months ago

The link is added to OF readme in section troubleshooting. @FritzHeiden can you add link to Troubleshooting from QUICK start please?

jpiesing commented 9 months ago

@FritzHeiden Please can you add a new section at the end of deploy / README.md which references this new text. Perhaps something like the following;

Debugging

If the observation framework reports errors and/or that the device has failed, some information on analysis and debugging can be found at https://github.com/cta-wave/device-observation-framework/wiki/Debugging-Observation-Failures

FritzHeiden commented 9 months ago

Done https://github.com/cta-wave/dpctf-deploy/pull/71

jpiesing commented 9 months ago

Looks good to me.