Skip to content

Commit

Permalink
Getting started
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Koshak <[email protected]>
  • Loading branch information
rkoshak committed Jul 8, 2022
1 parent c9aa2de commit ba98c7f
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 0 deletions.
7 changes: 7 additions & 0 deletions rules/actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copy over what's in the current Configuration -> Actions page.

Sort the content alphabetically so it's easier to find.

We need to decide what to do with the notification actions which require an add-on.

Move the persistence actions to here.
1 change: 1 addition & 0 deletions rules/blockly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Review the existing Blockly docs but they can probable be used as is.
25 changes: 25 additions & 0 deletions rules/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Cover generic rules concepts

Pull stuff from the Getting Started Tutorial.

## What Are Rules

## Parts of a Rule

### Triggers

### Conditions

### Script Actions

### Available Values

formerly implicit variables

### Helper Libraries

### Templates
How to find and install.
How to write will be on a later page.

### Comprehensive Examples
3 changes: 3 additions & 0 deletions rules/raw_api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Move the contents of the existing JSR223 page.

Expand the docs to include the `event` Object.
3 changes: 3 additions & 0 deletions rules/rules_dsl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
After removing the generic parts of the existing rules page, mainly focus reference to Rules DSL.

We need to add a section to discuss how to use the streaming api on Group's members which is missing from our docs and from the Xtext/Xtend docs too.
2 changes: 2 additions & 0 deletions rules/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
There's a tutorial on the forum to get started with this.
Reference the relevant developer docs too (i.e. how to format and constrain the properties).
5 changes: 5 additions & 0 deletions rules/text_rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Pretty much the same as the ui_rules.md page only showing the concepts for creating rules in text files.
Provide examples and reference heavily the langauge's docs.
Avoid being too language specific here.

Again, we mainly want to cover generic concepts.
5 changes: 5 additions & 0 deletions rules/ui_rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Copy the content of the Getting Started Tutorial and expand on it.

Make sure to cover all the triggers, (link to the concepts page where necessary), built in actions, and conditions.

Remember, this is a reference so it needs to be complete.

0 comments on commit ba98c7f

Please sign in to comment.