Add documentation templates

Signed-off-by: Antonio Jesus Navarro Perez <[email protected]>
src-d · Jun 28, 2018 · 84909e1 · 84909e1
1 parent d124e3b
commit 84909e1
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 3 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -1,4 +1,3 @@
-root: ./docs
-
 structure:
-  readme: ../README.md
+  readme: README.md
+  summary: docs/README.md
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,13 @@
+# gitbase
+
+* [Introduction](introduction.md)
+* [Join the community](join-the-community.md)
+
+### Using gitbase
+
+* [Getting started](using-gitbase/getting-started.md)
+* [Configuration](using-gitbase/configuration.md)
+* [Schema](using-gitbase/schema.md)
+* [Supported syntax](using-gitbase/supported-syntax.md)
+* [Functions](using-gitbase/functions.md)
+* [Examples](using-gitbase/examples.md)
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -0,0 +1,5 @@
+# Introduction
+
+## Motivation and scope
+
+## Further reading
diff --git a/docs/join-the-community.md b/docs/join-the-community.md
@@ -0,0 +1,7 @@
+# Join the community
+
+## Chat
+
+## Contributing
+
+## Reporting bugs
diff --git a/docs/using-gitbase/configuration.md b/docs/using-gitbase/configuration.md
@@ -0,0 +1,5 @@
+# Configuration
+
+## Environment variables
+
+## Executable parameters
diff --git a/docs/using-gitbase/examples.md b/docs/using-gitbase/examples.md
@@ -0,0 +1,10 @@
+# Examples
+
+## Get all the repositories where a specific user contributes on HEAD reference
+
+```sql
+SELECT refs.repository_id
+FROM refs
+NATURAL JOIN commits
+WHERE commits.commit_author_name = 'Javi Fontan' AND refs.ref_name='HEAD';
+```
diff --git a/docs/using-gitbase/functions.md b/docs/using-gitbase/functions.md
@@ -0,0 +1,7 @@
+# Functions
+
+## gitbase functions
+
+## Standard functions
+
+<!-- TODO add include to new markdown on go-mysql-server -->
diff --git a/docs/using-gitbase/getting-started.md b/docs/using-gitbase/getting-started.md
@@ -0,0 +1,8 @@
+# Getting started
+
+## Download an use the binary
+
+## Running with docker
+
+
+
diff --git a/docs/using-gitbase/schema.md b/docs/using-gitbase/schema.md
@@ -0,0 +1,7 @@
+# Schema
+
+## Main tables
+
+## Relation tables
+
+## Database diagram
diff --git a/docs/using-gitbase/supported-syntax.md b/docs/using-gitbase/supported-syntax.md
@@ -0,0 +1 @@
+## Supported syntax