diff --git a/.gitbook.yaml b/.gitbook.yaml index b159dc3e2..acc3619ba 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -1,4 +1,3 @@ -root: ./docs -​ structure: - readme: ../README.md + readme: README.md + summary: docs/README.md \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..d43e823e6 --- /dev/null +++ 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 new file mode 100644 index 000000000..19c6992ac --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,5 @@ +# Introduction + +## Motivation and scope + +## Further reading \ No newline at end of file diff --git a/docs/join-the-community.md b/docs/join-the-community.md new file mode 100644 index 000000000..457d9f005 --- /dev/null +++ b/docs/join-the-community.md @@ -0,0 +1,7 @@ +# Join the community + +## Chat + +## Contributing + +## Reporting bugs \ No newline at end of file diff --git a/docs/using-gitbase/configuration.md b/docs/using-gitbase/configuration.md new file mode 100644 index 000000000..b38cef6a0 --- /dev/null +++ b/docs/using-gitbase/configuration.md @@ -0,0 +1,5 @@ +# Configuration + +## Environment variables + +## Executable parameters \ No newline at end of file diff --git a/docs/using-gitbase/examples.md b/docs/using-gitbase/examples.md new file mode 100644 index 000000000..8bdb2228a --- /dev/null +++ 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'; +``` \ No newline at end of file diff --git a/docs/using-gitbase/functions.md b/docs/using-gitbase/functions.md new file mode 100644 index 000000000..f8ae3c1f3 --- /dev/null +++ b/docs/using-gitbase/functions.md @@ -0,0 +1,7 @@ +# Functions + +## gitbase functions + +## Standard functions + + \ No newline at end of file diff --git a/docs/using-gitbase/getting-started.md b/docs/using-gitbase/getting-started.md new file mode 100644 index 000000000..b38f19a81 --- /dev/null +++ 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 new file mode 100644 index 000000000..f9ff89b5b --- /dev/null +++ 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 new file mode 100644 index 000000000..7a4a922b4 --- /dev/null +++ b/docs/using-gitbase/supported-syntax.md @@ -0,0 +1 @@ +## Supported syntax \ No newline at end of file