Improve Getting Started Documentation — No Binary Approach

[mathewbyrne]

Addresses #408 — this is a set of improvements to the getting started documentation. The main change is deprecating using a global binary, and moving to always using dep to ensure users have a consistent version.

#415 discusses the whys for this approach.

[vektah]

did you update the template for resolvers.go?

[mathewbyrne]

Ah interesting. Yeah what should we do there? We can't assume users will have a script to run at scripts/gqlgen.go.

[mathewbyrne]

This seems to be enough to get init to run cleanly. Attempting to run server/server.go afterwards however still requires some additional deps (websockets I think). So I added a dep ensure after gqlgen init in the docs.

[emil-nasso]

Is it possible to add an explanation to what ./... means?

This is not unlikely to be the first run in with go generate for many users. The go documentation is not very good or clear on this.

To my understanding it runs go generate in all subdirectories so ./... means "the subdirectories (...) of the current directory (.)".

I think it would help to alleviate some confusion to just have a short explaination like:

You can now run any generation commands for all subdirectories in your project with:

[mathewbyrne]

@emil-nasso yeah I think that's a fair comment. I'll add a note.

[samjbobb]

Earlier the doc says:

mkdir -p $GOPATH/src/github.com/[username]/gqlgen-todos

So I think this doesn't match. Probably should be:

model: github.com/[username]/gqlgen-todos.Todo

[samjbobb]

For me, this is resolver.go no resolvers.go

[samjbobb]

I think (for me) this should be "Update resolver.go"

[samjbobb]

resolvers.go -> resolver.go (based on my experience)

[samjbobb]

Hey thanks for this project and this PR. This updated documentation really helped me get started.

I created a new project and set my Gopkg.toml to:

[[constraint]]
  name = "github.com/99designs/gqlgen"
  branch = "improved-getting-started"

And then ran through the Getting Started guide.

Overall, was successful and the new docs helped. I noticed a couple of discrepancies, so I added some commends to the PR. Hope that's helpful!

Thanks again.

[mathewbyrne]

@samjbobb thanks for the input. I think your comments are correct and I'll have a fix in place before this goes out.

Just an update for anyone else wanting this to be merged: since these docs use dep, they will only work once we have a new release out that includes these changes. Once we're ready for a new release (hopefully soon) this will go out.