Skip to content

Commit

Permalink
[doc] VS Code IDE setup (ray-project#613)
Browse files Browse the repository at this point in the history
VS Code setup for a project with multiple Go modules is tricky. Hence, this PR provides a workspace configuration for developers.

Signed-off-by: Kai-Hsun Chen <[email protected]>
  • Loading branch information
kevin85421 authored Oct 6, 2022
1 parent c074ef7 commit 0c94c16
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
20 changes: 20 additions & 0 deletions kuberay.code-workspace
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": {}
}
7 changes: 7 additions & 0 deletions ray-operator/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ export PATH="$GOROOT/bin:$PATH"

## Development

### IDE Setup (VS Code)
* Step 1: Install the [VS Code Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go).
* 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"

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.

### Build the source code

```
Expand Down

0 comments on commit 0c94c16

Please sign in to comment.