[SQL-261] Reactions tutorial rewrite #428
Conversation
doc/dev.md
Outdated
| @@ -117,4 +117,124 @@ java -cp bench.jar lrsql.bench [arguments] | |||
|
|
|||
| Sample insert and query inputs can be found in the distribution at `bench/` | |||
|
|
|||
| ### Reaction JSON | |||
There was a problem hiding this comment.
I'm honestly not sure if this the dev documentation page is best place to put the reactions spec, since it makes it pretty long. Instead would it be a better idea to make a separate page for the spec?
There was a problem hiding this comment.
I like separate page better I think
There was a problem hiding this comment.
Also, it is technically not just a private API, because we describe all the other "private" endpoints pretty well. So maybe the reactions spec goes in a subfolder of the main docs?
There was a problem hiding this comment.
These screenshots will be replaced with ones from the updated UI once that PR is merged.
kelvinqian00
changed the title
| @@ -8,166 +8,75 @@ Reactions allow SQL LRS to watch for patterns in submitted xAPI data and dynamic | |||
|
|
|||
There was a problem hiding this comment.
Since I did a full review, there's a typo on line 5. It should be "Reactions allows"
There was a problem hiding this comment.
Oh I keep thinking "Reactions" was plural. I always forget "Reactions" is also a copyrighted/trademarked noun referring to the whole thing.
doc/reactions.md
Outdated
|
|
||
| ### Conditions | ||
|
|
||
| `conditions` is a mapping of names to rules for finding significant statements. Rules can be composed with boolean logic. | ||
| Each condition is a set of rules for finding significant statements. Each condition has a unique name followed by its rules, which can be composed with boolean logic. |
There was a problem hiding this comment.
'significant' => 'relevant'
doc/reactions.md
Outdated
|
|
||
| In the example given above statement `a` must have an object id equal to `https://example.com/activities/a`, a verb id equal to `https://example.com/verbs/completed`, and a result success equal to `true`. Statement `b` must have the same verb and result success but an object id equal to `https://example.com/activities/b` and a timestamp greater than that of `a`. | ||
|  | ||
| In the example given, statement "alpha" must have an object `id` equal to `https://example.com/activities/alpha`, a verb `id` equal to `https://example.com/verbs/completed`, and its result `success` property equal to `true`. |
There was a problem hiding this comment.
just to illustrate the logic, I would write this as:
must have an object 'id' equal .... AND a verb 'id' equal to... AND 'result.success' property equal to
doc/reactions.md
Outdated
| * OR: Array of rules of which one must be true | ||
| * NOT: Rule that must _not_ be true | ||
|
|
||
| Rule types (either "Statement Criteria" or a boolean) can be selected using the topmost select input, or via the "Add sub-clause" button. |
There was a problem hiding this comment.
insert a section after boolean about nesting and how you can go as deep as you need to.
The current Reactions tutorial mainly uses JSON examples, but JSON is mainly used as an internal storage format. This rewrite uses screenshots from the Reactions UI, which the user actually interfaces with, on the Reactions page. Meanwhile, a description of the internal reactions spec (based on the tables used by the xAPI statement and profile specs), along with the JSON example, have been moved to the developer documentation page.