docs: update images and docs to reflect changes in v0.41.0
README - update the setup instruction. The "Analysis Tools Missing"
notification was removed and important tools are installed
automatically.
UI - Go status bar was moved to right, Language status bar is added.
Add the screenshot for Go explorer view. Rephrase the go version
management section to direct users to use GOTOOLCHAIN env var. But
we still need to rethink/rewrite this workflow.
Tools - mention the vscgo binary.
For golang/vscode-go#3167
Change-Id: Iad5528fdfcd9f9b282e6a873259e2c8cecdec227
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/562681
Commit-Queue: Hyang-Ah Hana Kim <hyangah@gmail.com>
Auto-Submit: Hyang-Ah Hana Kim <hyangah@gmail.com>
Reviewed-by: Suzy Mueller <suzmue@golang.org>
TryBot-Result: kokoro <noreply+kokoro@google.com>
diff --git a/README.md b/README.md
index 5239f24..15ca3d4 100644
--- a/README.md
+++ b/README.md
@@ -23,21 +23,17 @@
1. Install the [VS Code Go extension].
-1. Open any directory or workspace containing Go code to automatically activate
- the extension. The
+1. Open any Go file or go.mod file to automatically activate the extension. The
[Go status bar](https://github.com/golang/vscode-go/wiki/ui) appears in the
- bottom left corner of the window and displays your Go version.
+ bottom right corner of the window and displays your Go version.
-1. The extension depends on `go`, `gopls`, `dlv` and other optional tools. If
- any of the dependencies are missing, the ⚠️ `Analysis Tools Missing` warning
- is displayed. Click on the warning to download dependencies.
-
- See the
- [tools documentation](https://github.com/golang/vscode-go/wiki/tools) for a
- complete list of tools the extension depends on.
+1. The extension depends on `go`, `gopls` (the Go language server), and optional
+ tools depending on your settings. If `gopls` is missing, the extension will
+ try to install it. The :zap: sign next to the Go version indicates
+ the language server is running, and you are ready to go.
<p align="center">
-<img src="docs/images/installtools.gif" width=75%>
+<img src="docs/images/gettingstarted.gif" width=75%>
<br/>
<em>(Install Missing Tools)</em>
</p>
@@ -52,7 +48,8 @@
and [advanced topics](https://github.com/golang/vscode-go/wiki/advanced) to
customize the extension.
* View the [tools documentation](https://github.com/golang/vscode-go/wiki/tools)
- for a complete list of tools the VS Code Go extension depends on.
+ for a complete list of tools the VS Code Go extension depends on. You can
+ install additional tools and update them by using "Go: Install/Update Tools".
* Solve issues with the
[general troubleshooting](https://github.com/golang/vscode-go/wiki/troubleshooting)
and [debugging troubleshooting](https://github.com/golang/vscode-go/wiki/debugging#troubleshooting)
@@ -138,7 +135,7 @@
VS Code Go extension relies on the [Go Telemetry](https://telemetry.go.dev) to
learn insights about the performance and stability of the extension and the
-language server (`gopls``).
+language server (`gopls`).
**Go Telemetry data uploading is disabled by default** and can be enabled
with the following command:
diff --git a/docs/images/gettingstarted.gif b/docs/images/gettingstarted.gif
new file mode 100644
index 0000000..4f066bd
--- /dev/null
+++ b/docs/images/gettingstarted.gif
Binary files differ
diff --git a/docs/images/goexplorer.png b/docs/images/goexplorer.png
new file mode 100644
index 0000000..3a08deb
--- /dev/null
+++ b/docs/images/goexplorer.png
Binary files differ
diff --git a/docs/images/gopls.png b/docs/images/gopls.png
deleted file mode 100644
index ea8ab07..0000000
--- a/docs/images/gopls.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/gostatusbar.png b/docs/images/gostatusbar.png
new file mode 100644
index 0000000..94a0b8c
--- /dev/null
+++ b/docs/images/gostatusbar.png
Binary files differ
diff --git a/docs/images/languagestatusbar.png b/docs/images/languagestatusbar.png
new file mode 100644
index 0000000..39e5b42
--- /dev/null
+++ b/docs/images/languagestatusbar.png
Binary files differ
diff --git a/docs/images/selectGoVersion.png b/docs/images/selectGoVersion.png
deleted file mode 100644
index 85320df..0000000
--- a/docs/images/selectGoVersion.png
+++ /dev/null
Binary files differ
diff --git a/docs/images/statusbarmenu.png b/docs/images/statusbarmenu.png
deleted file mode 100644
index ae9d65a..0000000
--- a/docs/images/statusbarmenu.png
+++ /dev/null
Binary files differ
diff --git a/docs/tools.md b/docs/tools.md
index 7f04a3f..5c93bca 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -35,6 +35,13 @@
For a comprehensive overview of how to debug your Go programs, please see the [debugging guide](./debugging.md).
+### [`vscgo`](https://pkg.go.dev/github.com/golang/vscode-go/cmd/vscgo)
+
+This tool provides utilities needed by this extension but do not belong to the language server
+or debug adapter server. Examples include dependency tools management, developer survey
+configuration, and [Go telemetry collection](https://github.com/golang/vscode-go/issues/3121).
+This tool is released with the extension and installed in the extension's directory.
+
### [`goplay`](https://pkg.go.dev/github.com/haya14busa/goplay?tab=overview)
This tool provides support for the [`Go: Run on Go Playground`](features.md#go-playground) command.
diff --git a/docs/ui.md b/docs/ui.md
index 9860221..b9079be 100644
--- a/docs/ui.md
+++ b/docs/ui.md
@@ -2,10 +2,15 @@
## Using The Go Status Bar
-The Go status bar appears in the lower left of the extension window. Clicking the Go status bar brings up a menu that provides easy access to see and update important information about your Go project. This includes information about the Go environment, the current Go version, the `gopls` trace, and about the current module.
+The Go status bar appears in the lower right of the extension window, next to the Editor Language status bar item. Clicking the Go status bar brings up a menu that provides easy access to see and update important information about your Go project. This includes information about the Go environment, the current Go version, the `gopls` trace, and about the current module.
-<div style="text-align: center;"><img src="images/statusbarmenu.png" alt="vscode extension after Go status bar item is clicked" style="width:75%" > </div>
+<div style="text-align: center;"><img src="images/gostatusbar.png" alt="vscode extension after Go status bar item is clicked" style="width:75%" > </div>
+## Using The Language Status Bar
+
+The Language status bar shows status of dependency tools installation or availability of newly released Go versions.
+
+<div style="text-align: center;"><img src="images/languagestatusbar.png" alt="Go language status bar" style="width:75%" > </div>
### Go Environment
The `Go Locate Configured Go Tools` command will display the configured GOPATH, GOROOT, tool locations and the results of `go env` in the output window.
@@ -14,13 +19,18 @@
You can view the current Go version by looking at the status bar item in the bottom left corner of VS Code. Clicking this button and selecting `Choose Go Environment` will present you with a menu from which you can select any version of Go that exists in your $HOME/sdk directory or on <https://golang.org/dl>. This command is also available through the command pallette using `Go: Choose Go Environment`.
+If you are using go1.21 or newer, you can control your Go version using the `GOTOOLCHAIN` environment variable. See https://go.dev/doc/toolchain for more information. To tell the extension to use a different `GOTOOLCHAIN`, use the `go.toolsEnvVars` setting or the Go explorer view.
+
+```
+"go.toolsEnvVars": {
+ "GOTOOLCHAIN": "go1.21.0+auto"
+}
+```
+
+You will need to reload the window after updating this setting. We are working on improving the version switch workflow.
+
Previously, the `go.goroot` and `go.alternateTools` settings controlled the Go version used by VS Code Go. If you have configured these settings, they are no longer needed and should be deleted.
-<div style="text-align: center;"><img src="images/selectGoVersion.png" alt="command pallete menu for selecting a new Go version" style="width:75%" > </div>
-
-
-The "Clear Selection" option resets your Go version to the one found first in either `go.alternateTools`, `go.goroot` or your PATH.
-
### Installing a New Go Version
After selecting any Go version that has not yet been installed (such as Go 1.14.6 in the screenshot above), the binary will be automatically installed in $HOME/sdk and put to use in your environment.
@@ -31,9 +41,7 @@
`gopls` is the official Go [language server](https://langserver.org/) developed by the Go team. It was developed in response to the release of Go modules, and it is the recommended approach when working with Go modules in VS Code.
-When `gopls` is enabled, :zap: is displayed next to the Go version in the status bar and the `gopls` version is displayed in the menu.
-
-<div style="text-align: center;"><img src="images/gopls.png" alt="command pallete menu for selecting a new Go version" style="width:100px" > </div>
+When `gopls` is enabled, :zap: is displayed next to the Go version in the Go status bar and the `gopls` version is displayed in the menu.
Selecting `Open 'gopls' trace` will open the trace of the `gopls` server in the output window. Please include this trace when filing an issue related to the extension and `gopls` is enabled.
@@ -47,4 +55,6 @@
The view displays the go environment variables (`go env`) that are applied to the file open in the editor. You can customize the list by "Go: Edit Workspace" command (pencil icon), and update modifiable environment variables through this view.
-It displays required [tools](tools.md) and their location/version info, too.
\ No newline at end of file
+It displays required [tools](tools.md) and their location/version info, too.
+
+<div style="text-align: center;"><img src="images/goexplorer.png" alt="Go explorer view" style="width:75%" > </div>
\ No newline at end of file
