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

[doc] VS Code IDE setup #613

Merged
merged 3 commits into from
Oct 6, 2022
Merged

[doc] VS Code IDE setup #613

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fd8d6b
VS Code support
kevin85421 Oct 4, 2022
699c203
Update ray-operator/DEVELOPMENT.md
kevin85421 Oct 4, 2022
e35ef60
update
kevin85421 Oct 4, 2022
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
20 changes: 20 additions & 0 deletions kuberay.code-workspace
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"folders": [
{
"path": "."
},
{
"path": "ray-operator"
},
{
"path": "apiserver"
},
{
"path": "cli"
},
{
"path": "proto"
}
],
"settings": {}
}
8 changes: 8 additions & 0 deletions ray-operator/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ export PATH="$GOROOT/bin:$PATH"

## Development

### IDE Setup (VS Code)
* Step1: Install the [VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go).
kevin85421 marked this conversation as resolved.
Show resolved Hide resolved
* Step 2: Import the KubeRay workspace configuration by using the file `kuberay.code-workspace` in the root of the KubeRay git repo:
* "File" -> "Open Workspace from File" -> "kuberay.code-workspace"
kevin85421 marked this conversation as resolved.
Show resolved Hide resolved

Setting up workspace configuration is required because KubeRay contains multiple Go modules. See the [VS Code Go documentation](https://github.com/golang/vscode-go/blob/master/README.md#setting-up-your-workspace) for details.
* "File" -> "Open Workspace from File" -> "kuberay.code-workspace"
kevin85421 marked this conversation as resolved.
Show resolved Hide resolved

### Build the source code

```
Expand Down