Requested changes.

Signed-off-by: Antonio Jesus Navarro Perez <[email protected]>

Author: ajnavarro

Dockerfile

@@ -15,7 +15,7 @@ FROM ubuntu:16.04
 COPY --from=builder /go/bin/gitbase /bin
 RUN mkdir -p /opt/repos
 
-ENV GITBASE_USER=gitbase
+ENV GITBASE_USER=root
 ENV GITBASE_PASSWORD=""
 ENV GITBASE_REPOS=/opt/repos
 EXPOSE 3306

README.md

@@ -8,25 +8,23 @@ about the [Universal AST](https://doc.bblf.sh/) of the code itself. gitbase is b
 gitbase implements the *MySQL* wire protocol, it can be accessed using any MySQL
 client or library from any language.
 
-[src-d/go-mysql-server](https://github.com/src-d/go-mysql-server) is the project where the SQL engine used by ***gitbase*** is implemented.
+[src-d/go-mysql-server](https://github.com/src-d/go-mysql-server) is the SQL engine implementation used by `gitbase`.
 
 ## Status
 
 The project is currently in **alpha** stage, meaning it's still lacking performance in a number of cases but we are working hard on getting a performant system able to process thousands of repositories in a single node. Stay tuned!
 
 ## Examples
 
-You can see some examples [here](/docs/using-gitbase/examples.md).
-
-For more info about how to use it, see the [docs](/docs).
+You can see some [query examples](/docs/using-gitbase/examples.md) in [gitbase documentation](/docs).
 
 ## Motivation and scope
 
-gitbase was born to make easier the task of analyze git repositories and source code contained on them.
+gitbase was born to ease the analysis of git repositories and its source code.
 
-Also, making it MySQL compatible, we want the maximum compatibility between languages and existing tools.
+Also, making it MySQL compatible, we provide the maximum compatibility between languages and existing tools.
 
-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.
+As a single binary allows use it as a standalone service. The service is able to process local repositories or integrate with existing tools and frameworks (e.g. spark) to make source code analysis on the large scale.
 
 ## Further reading
 

docs/join-the-community.md

@@ -6,13 +6,12 @@ If you need support, want to contribute or just want to say hi, join us at the [
 
 ## Contributing
 
-You can start contributing in many ways
+You can start contributing in many ways:
 
-* [Reporting bugs.](/docs/join-the-community.md#reporting-bugs)
-* [Request a feature.](https://github.com/src-d/gitbase/issues)
-* Improve the [documentation](https://github.com/src-d/gitbase/docs).
-* Contribute code to [gitbase](https://github.com/src-d/gitbase),
-* Write a new data source using [go-mysql-server](https://github.com/src-d/go-mysql-server)
+* [Report bugs](/docs/join-the-community.md#reporting-bugs)
+* [Request a feature](https://github.com/src-d/gitbase/issues)
+* Improve the [documentation](https://github.com/src-d/gitbase/docs)
+* Contribute code to [gitbase](https://github.com/src-d/gitbase)
 
 ## Reporting bugs
 

docs/using-gitbase/configuration.md

@@ -11,7 +11,7 @@
 | `GITBASE_UNSTABLE_SQUASH_ENABLE` | enable join squash rule to improve query performance **experimental**. This optimization collects inner joins between tables with a set of supported conditions and converts them into a single node that retrieves the data in chained steps (getting first the commits and then the blobs of every commit instead of joining all commits and all blobs, for example).|
 | `GITBASE_SKIP_GIT_ERRORS`        | do not stop queries on git errors, default disabled |
 
-## Executable parameters
+## Command line arguments
 
 ```bash
 Please specify one command of: server or version

docs/using-gitbase/examples.md

@@ -15,7 +15,7 @@ WHERE commits.commit_author_name = 'Javi Fontan' AND refs.ref_name='HEAD';
 SELECT * FROM refs WHERE ref_name = 'HEAD'
 ```
 
-## Commits that appears in more than one reference
+## Commits that appear in more than one reference
 
 ```sql
 SELECT * FROM (
@@ -39,7 +39,7 @@ INNER JOIN commit_blobs cb
 GROUP BY c.commit_hash
 ```
 
-## Get commits per commiter, per month in 2015
+## Get commits per committer, per month in 2015
 
 ```sql
 SELECT COUNT(*) as num_commits, month, repo_id, committer_email

docs/using-gitbase/functions.md

@@ -2,7 +2,7 @@
 
 ## gitbase functions
 
-To make some common tasks easier for the user, there are some functions to interact with the previous mentioned tables:
+To make some common tasks easier for the user, there are some functions to interact with the aforementioned tables:
 
 |     Name     |                                               Description                                           |
 |:-------------|:----------------------------------------------------------------------------------------------------|
@@ -14,4 +14,4 @@ To make some common tasks easier for the user, there are some functions to inter
 
 ## Standard functions
 
-You can check standard functions from `go-mysql-server` [here](https://github.com/src-d/go-mysql-server/tree/5620932d8b3ca58edd6bfa4c168073d4c1ff665f#custom-functions).
+You can check standard functions in [`go-mysql-server` documentation](https://github.com/src-d/go-mysql-server/tree/5620932d8b3ca58edd6bfa4c168073d4c1ff665f#custom-functions).

docs/using-gitbase/getting-started.md

@@ -2,56 +2,56 @@
 
 ## Prerequisites
 
-**gitbase** has two optional dependencies that should be running on your system if you're planning on using certain functionality.
+`gitbase` has two optional dependencies that should be running on your system if you're planning on using certain functionality.
 
-- [bblfsh](https://github.com/bblfsh/bblfshd) >= 2.5.0 (only if you're planning to use the `UAST` functionality provided in gitbase).
-- [pilosa](https://github.com/pilosa/pilosa) 0.9.0 (only if you're planning on using indexes).
+- [bblfsh](https://github.com/bblfsh/bblfshd) >= 2.5.0 (only if you're planning to use the `UAST` functionality provided in gitbase)
+- [pilosa](https://github.com/pilosa/pilosa) 0.9.0 (only if you're planning on using indexes)
 
-## Download an use the binary
+## Download and use the binary
 
-Check the [Release](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
+Check the [Releases](https://github.com/src-d/gitbase/releases) page to download the gitbase binary.
 
-For more info about executable parameters, [go here](/docs/using-gitbase/configuration.md#executable-parameters).
+For more info about command line arguments, [go here](/docs/using-gitbase/configuration.md#command-line-arguments).
 
 You can start a server by providing a path which contains multiple git repositories `/path/to/repositories` with this command:
 
 ```
-$ gitbase server -v -g /path/to/repositories -u gitbase
+$ gitbase server -v -g /path/to/repositories
 ```
 
 ## Installing from source
 
 Because gitbase uses [bblfsh's client-go](https://github.com/bblfsh/client-go), which uses cgo, you need to install some dependencies by hand instead of just using `go get`.
 
-_Note_: we use `go get -d` so the code is not compiled yet, as it would
+**Note**: we use `go get -d` so the code is not compiled yet, as it would
 fail before `make dependencies` is executed successfully.
 
 ```
-go get -d github.com/src-d/gitbase
-cd $GOPATH/src/github.com/src-d/gitbase
-make dependencies
+$ go get -d github.com/src-d/gitbase
+$ cd $GOPATH/src/github.com/src-d/gitbase
+$ make dependencies
 ```
 
 ## Running with docker
 
 You can use the official image from [docker hub](https://hub.docker.com/r/srcd/gitbase/tags/) to quickly run gitbase:
 ```
-docker run --rm --name gitbase -p 3306:3306 -v /my/git/repos:/opt/repos srcd/gitbase:latest
+$ docker run --rm --name gitbase -p 3306:3306 -v /my/git/repos:/opt/repos srcd/gitbase:latest
 ```
 
-If you want to speedup gitbase using indexes, you must run a pilosa container:
+If you want to speedup gitbase using indexes you must run a pilosa container:
 ```
-docker run -it --rm --name pilosa -p 10101:10101 pilosa/pilosa:v0.9.0
+$ docker run -it --rm --name pilosa -p 10101:10101 pilosa/pilosa:v0.9.0
 ```
 
 Then link the gitbase container to the pilosa one:
 ```
-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
+$ 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
 ```
 
 ## Connecting to the server
 
-When the server is started, a MySQL client is needed to connect to the server. For example:
+When the server is started a MySQL client is needed to connect to the server. For example:
 
 ```bash
 $ mysql -q -u root -h 127.0.0.1
@@ -64,9 +64,4 @@ SELECT commit_hash, commit_author_email, commit_author_name FROM commits LIMIT 2
 | 01ace9e4d144aaeb50eb630fed993375609bcf55 | [email protected]       | Antonio Navarro Perez |
 +------------------------------------------+---------------------+-----------------------+
 2 rows in set (0.01 sec)
-```
-
-If gitbase is running in a container from the official image, you must use `gitbase` as user:
-```
-mysql -q -u gitbase -h 127.0.0.1
-```
+```

docs/using-gitbase/schema.md

@@ -67,7 +67,7 @@ This table contains all hash [git references](https://git-scm.com/book/en/v2/Git
 +---------------------+-----------+
 ```
 
-Commits contains all the [commits](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects) from all the references from all the repositories, not duplicated by repository. Note that you can have the same commit in several repositories. In that case, the commit will appears two times on the table, one per repository.
+Commits contains all the [commits](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects) from all the references from all the repositories, not duplicated by repository. Note that you can have the same commit in several repositories. In that case the commit will appear two times on the table, one per repository.
 
 > Note that this table is not only showing `HEAD` commits but all the commits on the repository (that can be a lot more than the commits on `HEAD` reference).
 
@@ -120,6 +120,8 @@ This table exposes blob objects, that are the content without path from files.
 
 `files` is an utility table mixing `tree_entries` and `blobs` to create files. It includes the file path.
 
+Queries to this table are expensive and they should be done carefully (applying filters or using directly `blobs` or `tree_entries` tables).
+
 ## Relation tables
 
 ### commit_blobs

pull_request_template.md

@@ -1,6 +1,6 @@
 <!--
 
-All PRs must keep up to date the documentation. If this PR changes or add some new behavior don't forget to check:
+All PRs must keep the documentation up to date. If this PR changes or adds some new behavior don't forget to check:
 
 - Schema changes
 - Syntax changes