FAQ

What assumptions are made in the guides?

Here is an incomplete list:

• You have Go installed 😄
• You have gobin installed. This greatly simplifies the process of installing tools
• You have $GOPATH/bin on your PATH. As a result, go install will place binaries in $GOPATH/bin (unless GOBIN is set, but we make this explicit where that is the case)

What are the high-level goals of these guides?

• Make it easy to add new guides (a guide comprises a human readable markdown file and a corresponding bash script)
• Ensure the script gives us reproducible results, where we can assert etc
• Reference the script (commands and output) from the corresponding markdown file
• Therefore have the entire guide (markdown and script) remain in sync