Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/APIScope.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/AdvancedFeaturesIndex.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doc/CodeReviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/DesignDocs.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 2 additions & 3 deletions doc/DockerBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/VtExplain.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down