diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index f206741a1..b2a4a370a 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -14,42 +14,11 @@ This page describes for new contributors how to make yourself familiar with Vite ## Learning Go -Vitess was one of the early adaptors of [Google's programming language Go](https://golang.org/). +Vitess was one of the early adaptors of [Google's programming language Go](https://golang.org/). We love it for its simplicity (e.g. compared to C++ or Java) and performance (e.g. compared to Python). -We love it for its simplicity (e.g. compared to C++ or Java) and performance (e.g. compared to Python). +Contributing to our server code will require you to learn Go. We recommend that you follow the [Go Tour](https://tour.golang.org/) to get started. -Contributing to our server code will require you to learn Go. We recommend to read the following resources. - -### Go Tour - -https://tour.golang.org/ - -The Go tour is a browser based tutorial which explains the different concepts of the programming language. -It's interactive i.e. you can change and run all examples on the right side. -The later steps also have specific exercises which you're supposed to implement yourself. -It's a lot of fun and demonstrates how simple it is to write Go code. - -### Go Readability - -While there's no Go style guide, there is a set of recommendations in the Go community which add up to an implicit style guide. To make sure you're writing idiomatic Go code, please read the following documents: - -* 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 - * Recommendations for writing good Go code. -* Go Code Review Comments: https://github.com/golang/go/wiki/CodeReviewComments - * The closest thing to a style guide. - -### Other Resources - -If you're unsure about Go's behavior or syntax, we recommend to look it up in the specification: https://golang.org/ref/spec -It is well written and easy to understand. - -### Appreciating Go - -After using Go for several weeks, we hope that you'll start to love Go as much as we do. - -In our opinion, the song "Write in Go" from ScaleAbility, a Google acapella band, perfectly captures what's so special about Go. Watch it and enjoy that you learnt Go: www.youtube.com/watch?v=LJvEIjRBSDA +[The Go Programming Language Specification](https://golang.org/ref/spec) is also useful as a reference guide. ## Learning Vitess @@ -57,7 +26,7 @@ Before diving into the Vitess codebase, make yourself familiar with the system a * Read the [What is Vitess](../overview/whatisvitess) page, in particular the architecture section. -* Read the [Vitess concepts](../overview/concepts) and the [Sharding](../reference/sharding) page. +* Read the [Concepts](../concepts) and [Sharding](../reference/sharding) pages. * We also recommend to look at our [latest presentations](../resources/presentations). They contain many illustrations which help understanding how Vitess works in detail. @@ -69,6 +38,6 @@ Before diving into the Vitess codebase, make yourself familiar with the system a -01, 01-02, ff- -* Go through the [Vitess Kubernetes tutorial](../get-started/kubernetes). +* Go through the [Kubernetes](../get-started/kubernetes) and [local](../get-started/local) get started guides. - * While going through the tutorial, look back at the [architecture](../overview/whatisvitess/#architecture) and match the processes you start in Kubernetes with the boxes in the diagram. + * While going through the tutorial, look back at the [architecture](../overview/architecture) and match the processes you start in Kubernetes with the boxes in the diagram.