documentation: Further VSCode instructions
BUG=None
TEST=None
Change-Id: Ibe23099fa081bba2fc780cc9f8f6e95df603dad8
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/tast/+/3423298
Tested-by: Marcello Salomao <[email protected]>
Auto-Submit: Marcello Salomao <[email protected]>
Reviewed-by: Hidehiko Abe <[email protected]>
Commit-Queue: Hidehiko Abe <[email protected]>
diff --git a/docs/quickstart.md b/docs/quickstart.md
index c0fdaa2..7e08a6c 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -62,6 +62,23 @@
code ./tast-tests ./tast
```
+Note: If you are using the VSCode "Remote-SSH" extension, restart
+VSCode's SSH server after setting the GOPATH, otherwise the Go
+extension won't pick it up. For example, using the VSCode command
+palette, you can run `>Remote-SSH: Kill VS Code Server on Host`.
+
+After that, it's useful to add the following to your settings JSON to
+avoid opening a 404 page whenever you try to follow links from import
+statements:
+
+```
+ "gopls": {
+ "ui.navigation.importShortcut": "Definition"
+ },
+```
+
+https://github.com/golang/vscode-go/issues/237#issuecomment-646067281
+
[modern editor]: https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins
[Visual Studio Code]: https://code.visualstudio.com/
[Microsoft Go plugin]: https://code.visualstudio.com/docs/languages/go
