Skip to content

Commit

Permalink
change default clone paths to FOLDER-OF-YOUR-CHOICE and clarify not t…
Browse files Browse the repository at this point in the history
…o use GOPATH

Signed-off-by: reggie-k <regina.voloshin@codefresh.io>
  • Loading branch information
reggie-k committed Jan 16, 2025
1 parent 1908500 commit 52cee4c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/developer-guide/contributors-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Before starting, ensure you have the following tools installed with the specifie

2. Clone the forked repository:
```shell
mkdir -p ~/go/src/github.com/argoproj/
cd ~/go/src/github.com/argoproj/
mkdir -p FOLDER-OF-YOUR-CHOICE/github.com/argoproj/
cd FOLDER-OF-YOUR-CHOICE/github.com/argoproj/
git clone https://github.com/YOUR-USERNAME/argo-cd.git
```

Please note that in order for all Argo CD `make` local development targets to function correctly, the Argo CD repo must be cloned under `~/go/src/`
Please note that the local build process uses GOPATH and that path should not be used, unless the Argo CD repository was directly cloned in it.

3. Add the upstream remote for rebasing:
```shell
Expand Down
6 changes: 3 additions & 3 deletions docs/developer-guide/toolchain-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ The following steps are required no matter whether you chose to use a virtualize

### Clone the Argo CD repository from your personal fork on GitHub

* `mkdir -p ~/go/src/github.com/argoproj`
* `cd ~/go/src/github.com/argoproj`
* `git clone https://github.com/yourghuser/argo-cd`
* `mkdir -p FOLDER-OF-YOUR-CHOICE/github.com/argoproj`
* `cd FOLDER-OF-YOUR-CHOICE/github.com/argoproj`
* `git clone https://github.com/YOUR-USERNAME/argo-cd`
* `cd argo-cd`

### Optional: Setup an additional Git remote
Expand Down

0 comments on commit 52cee4c

Please sign in to comment.