Skip to content

Commit 84909e1

Browse files
committed
Add documentation templates
Signed-off-by: Antonio Jesus Navarro Perez <[email protected]>
1 parent d124e3b commit 84909e1

10 files changed

+65
-3
lines changed

Diff for: .gitbook.yaml

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
root: ./docs
2-
31
structure:
4-
readme: ../README.md
2+
readme: README.md
3+
summary: docs/README.md

Diff for: docs/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# gitbase
2+
3+
* [Introduction](introduction.md)
4+
* [Join the community](join-the-community.md)
5+
6+
### Using gitbase
7+
8+
* [Getting started](using-gitbase/getting-started.md)
9+
* [Configuration](using-gitbase/configuration.md)
10+
* [Schema](using-gitbase/schema.md)
11+
* [Supported syntax](using-gitbase/supported-syntax.md)
12+
* [Functions](using-gitbase/functions.md)
13+
* [Examples](using-gitbase/examples.md)

Diff for: docs/introduction.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Introduction
2+
3+
## Motivation and scope
4+
5+
## Further reading

Diff for: docs/join-the-community.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Join the community
2+
3+
## Chat
4+
5+
## Contributing
6+
7+
## Reporting bugs

Diff for: docs/using-gitbase/configuration.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Configuration
2+
3+
## Environment variables
4+
5+
## Executable parameters

Diff for: docs/using-gitbase/examples.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Examples
2+
3+
## Get all the repositories where a specific user contributes on HEAD reference
4+
5+
```sql
6+
SELECT refs.repository_id
7+
FROM refs
8+
NATURAL JOIN commits
9+
WHERE commits.commit_author_name = 'Javi Fontan' AND refs.ref_name='HEAD';
10+
```

Diff for: docs/using-gitbase/functions.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Functions
2+
3+
## gitbase functions
4+
5+
## Standard functions
6+
7+
<!-- TODO add include to new markdown on go-mysql-server -->

Diff for: docs/using-gitbase/getting-started.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Getting started
2+
3+
## Download an use the binary
4+
5+
## Running with docker
6+
7+
8+

Diff for: docs/using-gitbase/schema.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Schema
2+
3+
## Main tables
4+
5+
## Relation tables
6+
7+
## Database diagram

Diff for: docs/using-gitbase/supported-syntax.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
## Supported syntax

0 commit comments

Comments
 (0)