blockr.process/_pkgdown.yml at main · cynkra/blockr.process · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
url: https://cynkra.github.io/blockr.process/

template:
  bootstrap: 5
  light-switch: true

navbar:
  structure:
    left: [intro, reference, articles, news]
    right: [demo, github]
  components:
    demo:
      text: Live demo
      href: https://blockr.cloud/app/data-collection
    articles:
      text: Articles
      menu:
      - text: Running scripts
        href: articles/running-scripts.html
      - text: Talking to other systems
        href: articles/external-systems.html

# Two layers, one namespace (dev/architecture.md): the engine -- pure R, no
# shiny -- and the blocks on top. The index reads in that order. Everything
# the namespace exports beyond this is machinery (functions that emitted
# block expressions call, demo scaffolding, semantics helpers) and is
# marked @keywords internal at the source.
reference:
- title: The process table
  desc: >
    A process definition is one wide table; these read it. Pure R.
  contents:
  - example_process
  - process_tasks
  - process_status
  - process_groups
  - process_version

- title: Instances and the event log
  desc: >
    An instance is an append-only event log; opening one stamps the
    definition and the element list into it. Current state is a fold over
    the lines. Pure R.
  contents:
  - start_instance
  - instance_event
  - instance_events
  - instance_view
  - instance_table
  - instance_status
  - instance_log
  - instance_latest
  - instance_definition
  - instance_collection
  - expand_instance
  - apply_events

- title: The worker
  desc: >
    The only thing in the package that executes anything -- a plain R
    process, deliberately outside the app.
  contents:
  - run_worker
  - process_act
  - worker_alive
  - process_interpreters
  - code_version

- title: The inbox
  desc: >
    How a system that is not R moves a process forward: one JSON file per
    message, the file name is the idempotency key.
  contents:
  - inbox_dir
  - write_inbox_message
  - ingest_inbox

- title: Blocks
  desc: The process on a blockr board.
  contents:
  - new_process_block
  - new_start_instance_block
  - new_tasks_block
  - new_bpmn_block
  - new_runstate_block
  - new_event_log_block
  - new_assign_block

- title: BPMN
  desc: >
    The diagram half -- tidy model, interchange XML in both directions,
    auto-layout with lanes and pools, widget. Pure R plus a bundled JS
    renderer; depends on nothing else in the package.
  contents:
  - bpmn
  - as_bpmn
  - read_bpmn
  - bpmn_to_table
  - bpmn_xml
  - write_bpmn
  - layout_bpmn
  - bpmn_widget
  - bpmnWidgetOutput
  - renderBpmnWidget