diff --git a/docs/developing.md b/docs/developing.md index 895ad1e..affbb32 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -19,25 +19,18 @@ This also allows us to delete and recreate our development cluster very quickly. To install docker-compose please follow the instructions for your platform [here](https://docs.docker.com/compose/install/). - ### Getting the source code -As of go 1.10.x, GOPATH is still relevant. This may change in the future but -for the sake of making development less error prone, it is suggested that the following -directories be created: +`$ git clone https://github.com/aurora-scheduler/gorealis` -`$ mkdir -p $GOPATH/src/github.com/paypal` +Inside of the newly cloned repo you may download dependencies to the local cache using go mod -And then clone the master branch into the newly created folder: - -`$ cd $GOPATH/src/github.com/paypal; git clone git@github.com:paypal/gorealis.git` - -Since we check in our vendor folder, gorealis no further set up is needed. +`$ go mod download` ### Bringing up the cluster -To develop gorealis, you will need a fully functioning Mesos cluster along with -Apache Aurora. +To develop gorealis, you will need a fully functioning Mesos cluster along with +the Aurora Scheduler. In order to bring up our docker-compose set up execute the following command from the root of the git repository: @@ -62,14 +55,14 @@ environment but not when running under MacOS. To run code involving the ZK leade For example, running the tests in a container can be done through the following command from the root of the git repository: -`$ docker run -t -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.10.3-alpine go test github.com/paypal/gorealis` +`$ docker run -t -v $(pwd):/go/src/github.com/aurora-scheduler/gorealis --network gorealis_aurora_cluster golang:1.14.3-alpine go test github.com/paypal/gorealis` Or `$ ./runTestsMac.sh` Alternatively, if an interactive shell is necessary, the following command may be used: -`$ docker run -it -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.10.3-alpine /bin/sh` +`$ docker run -it -v $(pwd):/go/src/github.com/paypal/gorealis --network gorealis_aurora_cluster golang:1.14.3-alpine /bin/sh` ### Cleaning up the cluster @@ -85,6 +78,3 @@ Once development is done, the environment may be torn down by executing (from th git directory): `$ docker-compose down` - - -