Skip to content

Commit c8a5b25

Browse files
committed
More documentation, mainly join the community section.
Signed-off-by: Antonio Jesus Navarro Perez <[email protected]>
1 parent 6a3e46f commit c8a5b25

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,16 @@ For more info about how to use it, see the [docs](/docs).
2222

2323
## Motivation and scope
2424

25+
gitbase was born to make easier the task of analyze git repositories and source code contained on them.
26+
27+
Also, making it MySQL compatible, we want the maximum compatibility between languages and existing tools.
28+
29+
Having that running on a simple binary allow us to use as a stand-alone service able to process some local repositories, or integrate it with other existing tools and frameworks like Spark to make large-scale source code analysis.
30+
2531
## Further reading
2632

33+
From here, you can directly go to [getting started](/docs/using-gitbase/getting-started.md).
34+
2735
## License
2836

2937
Apache License Version 2.0, see [LICENSE](LICENSE)

docs/join-the-community.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
## Chat
44

5+
If you need support, want to contribute or just want to say hi, join us at the [source{d} community Slack](https://join.slack.com/t/sourced-community/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM). We hang out in the #general channel.
6+
57
## Contributing
68

7-
## Reporting bugs
9+
You can start contributing in many ways
10+
11+
* [Reporting bugs.](/docs/join-the-community.md#reporting-bugs)
12+
* [Request a feature.](https://github.com/src-d/gitbase/issues)
13+
* Improve the [documentation](https://github.com/src-d/gitbase/docs).
14+
* Contribute code to [gitbase](https://github.com/src-d/gitbase),
15+
* Write a new data source using [go-mysql-server](https://github.com/src-d/go-mysql-server)
16+
17+
## Reporting bugs
18+
19+
Bugs should be reported through [GitHub Issues](https://github.com/src-d/gitbase/issues).

docs/using-gitbase/getting-started.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,21 @@ make dependencies
3737

3838
## Running with docker
3939

40+
You can use the official image from [docker hub](https://hub.docker.com/r/srcd/gitbase/tags/) to quickly run gitbase:
41+
```
42+
docker run --rm --name gitbase -p 3306:3306 -v /my/git/repos:/opt/repos srcd/gitbase:latest
43+
```
44+
45+
If you want to speedup gitbase using indexes, you must run a pilosa container:
46+
```
47+
docker run -it --rm --name pilosa -p 10101:10101 pilosa/pilosa:v0.9.0
48+
```
49+
50+
Then link the gitbase container to the pilosa one:
51+
```
52+
docker run --rm --name gitbase -p 3306:3306 --link pilosa:pilosa -e PILOSA_ENDPOINT="http://pilosa:10101" -v /my/git/repos:/opt/repos srcd/gitbase:latest
53+
```
54+
4055
## Connecting to the server
4156

4257
When the server is started,a MySQL client is needed to connect to the server. For example:

0 commit comments

Comments
 (0)