search

cta-wave / dpctf-test-runner

Repo for the DPCTF Test Runner
Other
0 stars 3 forks source link

test runner documentation is confusing mix of DPCTF and WPT #4

Closed jpiesing closed 3 years ago

jpiesing commented 3 years ago

The documentation in this project is a confusing mix of DPCTF and WPT.

louaybassbouss commented 3 years ago

@jpiesing the DPCTF Test Runner is built on top of the WMAS Test Runner which is built on top of the WPT Test Runner. We should add documentations specific to DPCTF or WMAS20XX Test Runners in the corresponding deploy projects. Maybe we should remove the DPCTF Section from the README and add a note at the top that DPCTF specific documentations are provided in the dpctf-deploy project.

Please put this as priority issue for our next call.

jpiesing commented 3 years ago

@jpiesing the DPCTF Test Runner is built on top of the WMAS Test Runner which is built on top of the WPT Test Runner. We should add documentations specific to DPCTF or WMAS20XX Test Runners in the corresponding deploy projects. Maybe we should remove the DPCTF Section from the README and add a note at the top that DPCTF specific documentations are provided in the dpctf-deploy project.

@louaybassbouss If I go to https://github.com/cta-wave/dpctf-test-runner and scroll down, past the list of files & directories, the first text I see is titled "The web-platform-tests Project" and is all about WPT. It would seem to be irrelevant to the purpose of running the dpctf test runner. Then there's a heading "DPCTF Info" with 2 paragraphs under it and then it goes back to text about the WPT. At very least, the DPCTF text should be first. Ideally there would be no WPT text here that was not directly relevant to someone trying to install and run the DPCTF test runner.

FritzHeiden commented 3 years ago

I added a section at the very top of the README.md containing DPCTF related details for the test runner. https://github.com/cta-wave/dpctf-test-runner#dpctf-test-runner

jpiesing commented 3 years ago

I added a section at the very top of the README.md containing DPCTF related details for the test runner. https://github.com/cta-wave/dpctf-test-runner#dpctf-test-runner

The section you added is OK. Why not remove all the rest?

FritzHeiden commented 3 years ago

I removed the rest

jpiesing commented 3 years ago

Looks good to me.