technofab/zfs-localpv
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/zfs-localpv.git synced 2025-12-11 22:10:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(doc): update docs for GO module support (#160)

Browse source 
Signed-off-by: vaniisgh <vanisingh@live.co.uk>>
This commit is contained in:
vaniisgh 2020-06-26 17:11:31 +05:30 • committed by GitHub
parent 13ec77c75e
commit 54f2b0b9fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 6 additions and 1003 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/developer-setup-examples.md
View file

@ -21,7 +21,7 @@ kubectl get pods -n kube-system -l role=openebs-zfs
export OPENEBS_NAMESPACE=openebs
export KUBECONFIG=$HOME/.kube/config
cd ~/go/src/github.com/openebs/zfs-localpv/tests
cd ~/path/to/directory/openebs/zfs-localpv/tests
ginkgo -v
```

12
docs/developer-setup.md
View file

@ -15,19 +15,14 @@
### Clone fork to local host
Place openebs/zfs-localpv's code on your `GOPATH` using the following cloning procedure.
Place openebs/zfs-localpv's code on your local machine using the following cloning procedure.
Create your clone:
```sh
mkdir -p $GOPATH/src/github.com/openebs
cd $GOPATH/src/github.com/openebs
# Note: Here user= your github profile name
git clone https://github.com/$user/zfs-localpv.git
# Configure remote upstream
cd $GOPATH/src/github.com/openebs/zfs-localpv
cd zfs-localpv
git remote add upstream https://github.com/openebs/zfs-localpv.git
# Never push to upstream master
@ -36,7 +31,6 @@ git remote set-url --push upstream no_push
# Confirm that your remotes make sense:
git remote -v
```
> **Note:** If your `GOPATH` has more than one (`:` separated) paths in it, then you should use *one of your go path* instead of `$GOPATH` in the commands mentioned here. This statement holds throughout this document.
Install the build dependencies.
* Run `make bootstrap` to install the required Go tools
@ -47,7 +41,7 @@ Install the build dependencies.
Open a terminal on your local host. Change directory to the zfs-localpv fork root.
```sh
$ cd $GOPATH/src/github.com/openebs/zfs-localpv
$ cd zfs-localpv
```
Checkout the master branch.