diff --git a/doc/APIScope.md b/doc/APIScope.md index 2442ff58e84..f51c7e51a94 100644 --- a/doc/APIScope.md +++ b/doc/APIScope.md @@ -31,7 +31,7 @@ The conventions Vitess follow is: ## Execute API -The main entry point of a Vitess cluster is the 'Execute' call (or StreamExecute +The main entry point of a Vitess cluster is the `Execute` call (or StreamExecute for streaming queries). It takes a keyspace, a tablet type, and a query. The VSchema helps Vitess route the query to the right shard and tablet type. This is the most transparent way of accessing Vitess. Keyspace is the database, and diff --git a/doc/AdvancedFeaturesIndex.md b/doc/AdvancedFeaturesIndex.md index 0c202e60393..c2fe3a753d2 100644 --- a/doc/AdvancedFeaturesIndex.md +++ b/doc/AdvancedFeaturesIndex.md @@ -1,6 +1,6 @@ # Advanced Features -The pages below this navigation entry "Advanced Features" can be understood as an addition to the "User Guide". Here we describe advanced Vitess features which you may want to enable or tune in a production setup. +The pages below this navigation entry `Advanced Features` can be understood as an addition to the `User Guide`. Here we describe advanced Vitess features which you may want to enable or tune in a production setup. As of October 2017, many of these features are not documented yet. We plan to add pages for them later. diff --git a/doc/CodeReviews.md b/doc/CodeReviews.md index 5ffd9130bc3..61e13385320 100644 --- a/doc/CodeReviews.md +++ b/doc/CodeReviews.md @@ -25,7 +25,7 @@ We usually check these kinds of things while skimming through `git diff --cached * Look for files that shouldn't be checked in (temporary/generated files). * Googlers only: Remove Google confidential info (e.g. internal URLs). * Look for temporary code/comments you added while debugging. - * Example: fmt.Println("AAAAAAAAAAAAAAAAAA") + * Example: fmt.Println(`AAAAAAAAAAAAAAAAAA`) * Look for inconsistencies in indentation. * Use 2 spaces in everything except Go. * In Go, just use goimports. diff --git a/doc/Contributing.md b/doc/Contributing.md index 1e1a662046a..70bf486e408 100644 --- a/doc/Contributing.md +++ b/doc/Contributing.md @@ -30,7 +30,7 @@ To make sure you're writing idiomatic Go code, please read the following documen * Go Readability slides: https://talks.golang.org/2014/readability.slide * Talk about Go readability with many specific examples. -* "Effective Go": https://golang.org/doc/effective_go.html +* `Effective Go`: https://golang.org/doc/effective_go.html * Recommendations for writing good Go code. * Go Code Review Comments: https://github.com/golang/go/wiki/CodeReviewComments * The closest thing to a style guide. diff --git a/doc/DesignDocs.md b/doc/DesignDocs.md index f4d06fa0f59..0fa0e422cd6 100644 --- a/doc/DesignDocs.md +++ b/doc/DesignDocs.md @@ -1,4 +1,4 @@ -The pages below this navigation entry "Design Docs" represent the design considerations +The pages below this navigation entry `Design Docs` represent the design considerations that went behind some of the features implemented. They may not be necessarily up-to-date. Also, some of the ideas here may just be experimental proposals, and it's possible diff --git a/doc/DockerBuild.md b/doc/DockerBuild.md index bb88d3c7b5d..986b8e672c6 100644 --- a/doc/DockerBuild.md +++ b/doc/DockerBuild.md @@ -12,7 +12,7 @@ Another alternative is to customize our Docker images and build them yourselves. This is described below and involves building the `base` image first. Then you can run our build script for the `lite` image which extracts the Vitess binaries from the built `base` image. -1. Install [Docker](https://www.docker.com/) on your workstation. +1. Install [Docker](https://docs.docker.com/v17.12/install/) on your workstation. Our scripts also assume you can run the `docker` command without `sudo`, which you can do by [setting up a docker group](https://docs.docker.com/engine/installation/linux/ubuntulinux/#create-a-docker-group). @@ -22,8 +22,7 @@ Then you can run our build script for the `lite` image which extracts the Vitess 1. Go to your `src/vitess.io/vitess` directory. -1. Usually, you won't need to [build your own bootstrap image] - (https://github.com/vitessio/vitess/blob/master/docker/bootstrap/README.md) +1. Usually, you won't need to [build your own bootstrap image](https://github.com/vitessio/vitess/blob/master/docker/bootstrap/README.md) unless you edit [bootstrap.sh](https://github.com/vitessio/vitess/blob/master/bootstrap.sh) or [vendor.json](https://github.com/vitessio/vitess/blob/master/vendor/vendor.json), for example to add new dependencies. If you do need it then build the diff --git a/doc/VtExplain.md b/doc/VtExplain.md index 22e916b50b4..93d06a8f0c3 100644 --- a/doc/VtExplain.md +++ b/doc/VtExplain.md @@ -1,6 +1,6 @@ # VTExplain Tool -The vtexplain tool provides information about how Vitess will execute a statement (the Vitess version of MySQL "EXPLAIN"). +The vtexplain tool provides information about how Vitess will execute a statement (the Vitess version of MySQL `EXPLAIN`). ## Prerequisites