search

ReproNim / reproschema

A standardized form generation and data collection schema to harmonize results by design across projects.
https://www.repronim.org/reproschema/
Other
14 stars 20 forks source link

Walked through tutorial and didn't succeed #494

Open dnkennedy opened 2 months ago

dnkennedy commented 2 months ago

Hi. I tried to [sort of] follow the tutorial in the main documentation here.

I generated a protocol, and propagated it to my GitHub here.

My protocol pretty much followed the example tutorial protocol, using the phq9 example (tho in my real world case I will need to change that, but that's another discussion).

Thus, when I come to the "see how it looks" step, I believe that protocol url is: https://raw.githubusercontent.com/dnkennedy/SimpleAssessment/main/protocols/simple.jsonld

and therefore I should be able to view this using: https://www.repronim.org/reproschema-ui/#/?url=https://raw.githubusercontent.com/dnkennedy/SimpleAssessment/main/protocols/simple.jsonld

When I enter this in the (Chrome Version 125.0.6422.142 (Official Build) (x86_64)) browser I just get a spinning (binder-like?) wheel of death that never does anything.

I did use the jasonld validator, and that seemed OK.

I also know that there may be other example's I could have tried (cookie-cutter, etc.) but this was the first obvious tutorial I ran across.

Let me know what I missed!

dnkennedy commented 2 months ago

Nevermind, user error on my part in the protocol file.

In the step where the assessment is added, there are changes both at the top in the 'context', and the added 'ui' content at the end of the file. Somehow the earlier instruction regarding "(and unless we explicitly say so) any new content we add to a file we have already worked on will be put at the end of this file" made me attend to only the 'ui' added content and I missed the update to the 'context'. Might be good to explicitly point out this 'context' update.

Remi-Gau commented 2 months ago

Thanks for the feedback!!!

We are planning to update the doc and refactor some redundancies. It is WIP (see for example: https://github.com/ReproNim/reproschema/pull/487)

One thing I'd like to add is highlighting of the changed lines followed by an explanation why they were changed.

image

Remi-Gau commented 2 months ago

That being said I cannot tell you how many times I created some activity or protocol that was jsonld valid and reproschema valid only to end on the spinning wheel of death.

dnkennedy commented 2 months ago

+1 (or even +100!) to the highlighting of the changes. So officially, my issue is resolved. I will close this?

Remi-Gau commented 2 months ago

Don't close it yet: just to make sure we have it as a reminder.

yibeichan commented 2 months ago

thanks @dnkennedy and @Remi-Gau!! sorry, i can't get emails from github issues if I'm not tagged (I did check all my email settings)... yes, the highlight would be great! how do we do it ... @Remi-Gau you probably have magic tools...

Remi-Gau commented 2 months ago

Latest version of the doc includes code highlighting

https://www.repronim.org/reproschema/tutorials/finalizing-the-protocol/#adding-the-activity-to-the-protocol

image

Not sure why it's blue here and yellow when I try this locally.

Remi-Gau commented 2 months ago

@yibeichan

here is how to highlight specific lines:

https://github.com/ReproNim/reproschema/blob/125993b5fbe5b93d1fd72df18a12dcb621e9db02/docs/tutorials/finalizing-the-protocol.md?plain=1#L24

yibeichan commented 2 months ago

cool! it's blue on my screen too! Blue aligns well with reproschema/repronim's theme color.