Added more detailed instructions on how to setup the repo #1114
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
docs/devguide.md
Outdated
| git clone https://github.com/$user/service-catalog.git | ||
| # or: git clone git@github.com:$user/service-catalog.git | ||
|
|
||
| cd $working_dir/service-catalog |
There was a problem hiding this comment.
nit: technically it could just be cd service-catalog
docs/devguide.md
Outdated
| The Service Catalog github repository can be found | ||
| [here](https://github.com/kubernetes-incubator/service-catalog.git). | ||
| ### 1 Fork in the Cloud | ||
| 1. Visit Visit https://github.com/kubernetes-incubator/service-catalog |
| @@ -88,14 +88,50 @@ also need: | |||
| a Kubernetes cluster. As such, our build process only supports compilation of | |||
| linux/amd64 binaries suitable for execution within a Docker container. | |||
|
|
|||
| ## Cloning the Repo | |||
| ## Workflow | |||
| We can set up the repo by following a process similar to the [dev guide for k8s]( https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#1-fork-in-the-cloud) | |||
There was a problem hiding this comment.
it'd be nice to wrap this at 80 cols.
There was a problem hiding this comment.
I think this one wraps at exactly 80 but the markup doesn't
docs/devguide.md
Outdated
|
|
||
| $ git clone https://github.com/kubernetes-incubator/service-catalog.git | ||
| Per Go's workspace instructions, place Service Catalog's code on your GOPATH using the following cloning procedure. |
|
CI failure looks real: Overall, it SGTM, just a few nits. |
|
Fixed the issues. @duglin Is it OK that I copied part of the k8s dev guide? |
|
I don't see why not, but if it reads ok just having a pointer to the kube docs (so we don't duplicate or get our of sync) would be good too. |
|
I see your point and agree it works either way. Also, I think it won't be out of sync since these are standard git workflow instructions, so having them there saves a click. |
This change adds instructions to setup the repo locally. On my first experience with the code base I lost a lot of time running a single test through docker. I was unable to run
go test ./...because I had naively cloned my fork. So I did some research and found the proper way to set up the repo in the k8s dev guide So I decided to add those instructions to help people jumping in the code.PS. I copied most of the words from those instructions and referenced the guide. Is this OK or do I need to paraphrase?