summaryrefslogtreecommitdiff
path: root/docs/user-guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user-guide.md')
-rw-r--r--docs/user-guide.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/user-guide.md b/docs/user-guide.md
new file mode 100644
index 0000000..b47a609
--- /dev/null
+++ b/docs/user-guide.md
@@ -0,0 +1,28 @@
+# Introduction
+
+ GrootStream is a real-time ETL platform based on the concepts of flow-based programing. Groot provides a template to quickly build a data flow job. It includes sources, filters, processing pipelines and sinks etc.
+The main format of the config template file is `yaml`, for more details of this format type you can refer to [YAML-GUIDE](https://yaml.org/spec/1.2/spec.html).
+
+# Job Config
+
+## Config file structure
+
+## Schema
+
+## Sources
+
+
+## Filters
+
+## Processing Pipelines
+
+## Sinks
+
+## Application
+
+### ENV
+
+
+
+
+