Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added details to GOOS / GOARCH and "Run it" instructions #52

Merged
merged 2 commits into from
Apr 22, 2019

Conversation

sam-fs
Copy link
Contributor

@sam-fs sam-fs commented Apr 19, 2019

Added instructions for finding GOOS and GOARCH values.

Edited the "Run it" instructions so they will work when in a directory not on GOPATH.

Copy link
Contributor

@jameremo jameremo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small comments. Basically I think if we're going to go down the path of trying to educate people who don't know Go, we may have to add a bit more than what is in this first revision.

README.md Outdated
@@ -13,8 +13,11 @@ SQL recipes for Data Export analysis are in the [Data Export Cookbook](https://g
## Quick Start
* Make sure you have [installed](https://golang.org/doc/install) Go 1.9 or higher.
* Build it (for EC2, for example): ``GOOS=linux GOARCH=amd64 go get github.com/fullstorydev/hauser``
- Type `go version` to find your `GOOS` and `GOARCH` values.
- Example (macOS): `go1.11.5 darwin/amd64` is `GOOS=darwin GOARCH=amd64`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's really 2 uses cases to cover with respect to GOOS and GOARCH here:

  1. You're building it in order to to run/test it locally. In this case, you don't even need to set these two variables, as your Go installation will assume they should have values matching your system.
  2. You're cross-compiling it in order to deploy it to a VM or Docker container somewhere in the cloud, in which case the values you need to choose values that match your deployment target. This is what I think we originally wrote the docs for, since it says "for EC2, for example". In this case, maybe it's helpful to include a link to all the possible values for these two variables.

Is it fair to say the first case will be that of data scientists looking to "play" with our data exports? Someone like me who wants to set up a permanent ETL pipeline would likely be interested in the second case.

README.md Outdated
* Copy the included `example-config.toml` file and customize it for your environment, including your FullStory API key, warehouse host, and credentials. AWS credentials (for S3) come from your local environment.
* Run it: `./hauser -c <your updated config file>`
* Run it: `$GOPATH/bin/hauser -c <your updated config file>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may need to go deeper down the rabbit hole of people not knowing Go here; this change assumes that your GOPATH is set. If it's not set it has a default value, so the go get command will succeed, but we'll still fail to run here. (as you can see I found all the official Go docs on this subject since we last talked!)

@sam-fs
Copy link
Contributor Author

sam-fs commented Apr 22, 2019 via email

Copy link
Contributor

@jameremo jameremo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sam-fs sam-fs merged commit 37cb8d6 into master Apr 22, 2019
@sam-fs sam-fs deleted the sam/update-readme branch April 22, 2019 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants