summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2021-12-07 09:23:00 +0000
committerPaul Buetow <paul@buetow.org>2021-12-07 09:23:00 +0000
commit1fa1f0329442c555635460221c809fecdaa977a7 (patch)
tree65a8060a974f570ef4b1180fc6373d63e2ab5d57
parent6031ce78df6cda9c8b924b231554bb4e0c077358 (diff)
initial logformats and querylanguage documentation
-rw-r--r--README.md5
-rw-r--r--doc/index.md14
-rw-r--r--doc/logformats.md4
-rw-r--r--doc/querylanguage.md18
4 files changed, 37 insertions, 4 deletions
diff --git a/README.md b/README.md
index c40a244..8a0ac57 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,7 @@ If you like what you see [look here for more examples](doc/examples.md)! You can
Installation and Usage
======================
-* Check out the [Testing Guide](doc/testing.md) for unit and integration testing.
-* For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md).
-* For a more sustainable setup, please follow the [Installation Guide](doc/installation.md).
-* Please also look at the [Usage Examples](doc/examples.md).
+* Check out the [DTail Documentation](doc/index.md)
More
====
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..9a5a42f
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,14 @@
+DTail Documentation
+===================
+
+## Installation and Usage
+
+* To get a taste, please have a look at the [Usage Examples](./examples.md).
+* Follow the [Quick Starting Guide](./quickstart.md) if you are looking into DTail your first time.
+* For a more sustainable setup, please follow the [Installation Guide](./installation.md).
+
+## Advanced topics
+
+* The [DTail Query Language)(./querylanguage.md) is the starting point to dig deeper into DTail's own SQL-like mapreduce language for extracting stats from log files.
+* [Log Formats](./logformats.md) explains how to create your own custom log format for use with mapreduce queries.
+* Check out the [Testing Guide](./testing.md) for unit and integration testing.
diff --git a/doc/logformats.md b/doc/logformats.md
new file mode 100644
index 0000000..a9f9865
--- /dev/null
+++ b/doc/logformats.md
@@ -0,0 +1,4 @@
+Log Formats
+===========
+
+TODO: document log formats.
diff --git a/doc/querylanguage.md b/doc/querylanguage.md
new file mode 100644
index 0000000..9f38f5e
--- /dev/null
+++ b/doc/querylanguage.md
@@ -0,0 +1,18 @@
+DTail Query Language
+====================
+
+The query language allows you to run mapreduce queries on log files. This page intends to be a reference to the language.
+
+## Prerequisites
+
+For this to work, DTail needs to understand your log format. DTail already understands its own log format. You can have a look at all examples of the [examples](./examples.md) page using `-query` (these would be all examples of the `dmap` command, and some examples using the `dtail` command).
+
+DTail also ships with a generic log format, which only allows you to run very basic queries. Check out the [log formats](./logformats.md) documentation for this.
+
+To implement your own log format, please also check out the [log formats](./logformats.md) documentation.
+
+## The complete language
+
+```
+TODO: Add EBNF
+```