Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Update dev guide to not refer to GOPATH in setup #2808

Merged
merged 1 commit into from
May 22, 2020
Merged

Update dev guide to not refer to GOPATH in setup #2808

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 3 additions & 20 deletions docs/devguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,25 +72,8 @@ We can set up the repo by following a process similar to the [dev guide for k8s]

### 2 Clone fork to local storage

Per Go's workspace instructions, place Service Catalog's code on your GOPATH
using the following cloning procedure.

Define a local working directory:

> If your GOPATH has multiple paths, pick
> just one and use it instead of $GOPATH.

> You must follow exactly this pattern,
> neither `$GOPATH/src/github.com/${your github profile name}/`
> nor any other pattern will work.

From your shell:
```bash
# Run the following only if `echo $GOPATH` shows nothing.
export GOPATH=$(go env GOPATH)

# Set your working directory
working_dir=$GOPATH/src/github.com/kubernetes-sigs

# Set user to match your github profile name
user={your github profile name}
Expand Down Expand Up @@ -126,7 +109,7 @@ layout:
├── cmd # Contains "main" Go packages for each service catalog component binary
│   ├── controller-manager # The service catalog controller manager service-catalog command
│   ├── service-catalog # The service catalog binary, which is used to run commands
│ └── svcat # The command-line interface for interacting with kubernetes service-catalog resources
│ ├── svcat # The command-line interface for interacting with kubernetes service-catalog resources
│ └── webhook # The service catalog webhook server command
├── contrib # Contains examples, non-essential golang source, CI configurations, etc
│   ├── build # Dockerfiles for contrib images (example: ups-broker)
Expand All @@ -141,8 +124,8 @@ layout:
├── plugin # Plugins for API server
├── test # Integration and e2e tests
├── vendor # dep-managed dependencies
├── Gopkg.toml # dep manifest
└── Gopkg.lock # dep lock (autogenerated, do not edit)
├── go.mod # defines projects requirements and locks dependencies
└── go.sum # the expected cryptographic checksums of go.mod dependencies

## Building

Expand Down