summaryrefslogtreecommitdiff
path: root/doc/index.md
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 /doc/index.md
parent6031ce78df6cda9c8b924b231554bb4e0c077358 (diff)
initial logformats and querylanguage documentation
Diffstat (limited to 'doc/index.md')
-rw-r--r--doc/index.md14
1 files changed, 14 insertions, 0 deletions
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.