From 3c28ef821b429978bdf303374f0d4653de0857c9 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 10 May 2024 18:39:58 +0200 Subject: [PATCH 1/4] [MAINT] ensures precommit is run on master --- .github/workflows/run_precommit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/run_precommit.yml b/.github/workflows/run_precommit.yml index 97100d0bd..288c452a7 100644 --- a/.github/workflows/run_precommit.yml +++ b/.github/workflows/run_precommit.yml @@ -4,7 +4,7 @@ name: pre-commit on: pull_request: push: - branches: [main] + branches: [master] jobs: pre-commit: From bedf2ff74fd45257d5855f8907201947c575e27f Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 10 May 2024 12:45:01 -0400 Subject: [PATCH 2/4] fix spelling --- docs/30_schema.md | 2 +- docs/50_using_reproschema.md | 6 +++--- docs/51_create_new_protocol.md | 12 +++++------- docs/53_tips_to_make_your_life_easier.md | 2 +- docs/54_translating_an_activity.md | 4 +--- docs/55_collecting_demographics_information.md | 5 +---- mkdocs.yml | 4 ++-- mlc_config.json | 2 +- 8 files changed, 15 insertions(+), 22 deletions(-) diff --git a/docs/30_schema.md b/docs/30_schema.md index 63bf5bc8a..4758b28f8 100644 --- a/docs/30_schema.md +++ b/docs/30_schema.md @@ -25,7 +25,7 @@ You can see an example of those in the [examples folder](https://github.com/Repr There are in fact more levels than this each and each level has its own schema: - all of the schemas can be found in the [`terms` folder](https://github.com/ReproNim/reproschema/terms) -- the Reproschema actually allows for a more complex level nesting than the one described above (e.g you can have an `activity` wihtin an `activity`) +- the Reproschema actually allows for a more complex level nesting than the one described above (e.g you can have an `activity` within an `activity`) - all the properties of each level are described below in the [Properties of ReproSchema objects section](#properties-of-reproschema-objects) ## Detailed description diff --git a/docs/50_using_reproschema.md b/docs/50_using_reproschema.md index 986e33bcf..e391bbdf1 100644 --- a/docs/50_using_reproschema.md +++ b/docs/50_using_reproschema.md @@ -18,7 +18,7 @@ For this tutorial you will be using some other tools to put your work online. He We don't assume that you have in-depth knowledge of Git and Github for this tutorial so we will try to provide with the commands you need to type when it is required. Similarly, we will provide some of the commands to create directories and files though you could do many of those actions "by hand" with a couple of mouse clicks. ??? "For Windows users" - Most of the commands we will provide should work in the command line interface that will come on your computer when you isntall Git. But you could also look into using one the linux sub-system that provide you with Unix command line and that can be easily installed from the app-store on your computer. + Most of the commands we will provide should work in the command line interface that will come on your computer when you install Git. But you could also look into using one the linux sub-system that provide you with Unix command line and that can be easily installed from the app-store on your computer. ## Context @@ -35,7 +35,7 @@ So we would want to have a set of questionnaires: We will be creating several jsonld files in this tutorial. Those can quickly grow big and it can be hard to see what was added to a certain file from one step to the next. This gets even more confusing when you know that the order of the lines does not really matter. So to makes things easier to follow (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. -So if step 1 looked like this: +So if step 1 looked like this: ```json { @@ -82,4 +82,4 @@ Although some other possibility would be equivalent: "schemaVersion": "1.0.0", "version": "0.0.1", } -``` \ No newline at end of file +``` diff --git a/docs/51_create_new_protocol.md b/docs/51_create_new_protocol.md index 6d522aa10..0cb9a19e7 100644 --- a/docs/51_create_new_protocol.md +++ b/docs/51_create_new_protocol.md @@ -9,7 +9,7 @@ We first need to create some folders to host the schema that will represent all ```bash # Type this in a terminal window -# FYI: this line starts with # +# FYI: this line starts with # # it is comment and it will not be executed # if you copy paste it in the command line @@ -168,11 +168,11 @@ Let's just highlight the things that have changed. We have added a `ui` and an `order` fields. -`ui` is for things realted to the user interface and contains `addProperties` where we will be listing all the assessments that we add to our protocol. +`ui` is for things related to the user interface and contains `addProperties` where we will be listing all the assessments that we add to our protocol. Each assessment is represented by an activity that is given a `variableName` and a `prefLabel`. The latter will be used as the name to display on the UI in english. -The field `isAbout` is the URL to point to the schema of that activity. +The field `isAbout` is the URL to point to the schema of that activity. The field `order` is there to indicate which activity should be presented first, second... @@ -181,8 +181,8 @@ The field `order` is there to indicate which activity should be presented first, ??? "JSON-LD expansion" You might notice that `rl:PHQ-9/PHQ9_schema` does not look like a typical URL and clearly does not match the one we fed the UI earlier (https://raw.githubusercontent.com/ReproNim/reproschema-library/master/activities/PHQ-9/PHQ9_schema). Well this is because we have defined, in the `@context` part of our jsonld, that the `rl` from `rl:PHQ-9/PHQ9_schema` will actually stand for `https://raw.githubusercontent.com/ReproNim/reproschema-library/master/activities/`. This shorthand makes it faster for us to write URL but the UI will know how to `expand` this into an actual URL. - - Similarly the `reproschema:Protocol` in `"@type": "reproschema:Protocol"` expands in `http://schema.repronim.org/Protocol` because `reproschema` has been indirectly defined in the context of `depression_nimg_schema.jsonld`. To be more precise `reproschema` is defined in the [base file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/base) which is part of the context of the [generic file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/generic) that our protocol points to. + + Similarly the `reproschema:Protocol` in `"@type": "reproschema:Protocol"` expands in `http://schema.repronim.org/Protocol` because `reproschema` has been indirectly defined in the context of `depression_nimg_schema.jsonld`. To be more precise `reproschema` is defined in the [base file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/base) which is part of the context of the [generic file](https://raw.githubusercontent.com/ReproNim/reproschema/1.0.0-rc1/contexts/generic) that our protocol points to. @@ -254,5 +254,3 @@ git add --all git commit -m 'add a thank you activity' git push ``` - - diff --git a/docs/53_tips_to_make_your_life_easier.md b/docs/53_tips_to_make_your_life_easier.md index e6585b7ad..855338fcc 100644 --- a/docs/53_tips_to_make_your_life_easier.md +++ b/docs/53_tips_to_make_your_life_easier.md @@ -45,7 +45,7 @@ every time there some new content is added on a repository. To set those up you simply need to create a `.github/workflows` folder inside the repository where you are working. This will contain all the workflows (a set of "actions") that Github has to run on this repository. Each workflow is -decribed by a `yml` file. +described by a `yml` file.