Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update development guide #654

Merged
merged 3 commits into from
Sep 7, 2021
Merged

update development guide #654

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0149b19
update development guide
cjerad Sep 2, 2021
61b1eb2
update toolchain.sh
cjerad Sep 2, 2021
1f0e713
update toolchain.sh
cjerad Sep 3, 2021
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
3 changes: 2 additions & 1 deletion website/content/en/docs/development-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following tools are required for contributing to the Karpenter project.
| [go](https://golang.org/dl/) | v1.15.3+ | [Instructions](https://golang.org/doc/install) |
| [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) | | `brew install kubectl` |
| [helm](https://helm.sh/docs/intro/install/) | | `brew install helm` |
| Other tools | | `make toolchain` |
| Other tools | | `make toolchain` then ensure `PATH` contains Go workspace's `bin` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of putting this here, what do you think about adding some output in the toolchain.sh script to echo something like: PATH=$PATH:$GOPATH/bin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🆗


## Developing

Expand All @@ -39,6 +39,7 @@ make delete # Uninstall Karpenter
### Build and Deploy
```
make dev # build and test code
kubectl create namespace karpenter # create target namespace for deployment
Copy link
Contributor

@ellistarn ellistarn Sep 2, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch. We typically have this namespace created as part of the getting-started guide (helm install --create-namespace), but this is a great note to have here.

make apply # deploy local changes to cluster
CLOUD_PROVIDER=<YOUR_PROVIDER> make apply # deploy for your cloud provider
```
Expand Down