Improve Extension Documentation #942
Conversation
jpogran
force-pushed
the
update_readme
branch
2 times, most recently
from
dd61013
to
3bafc8e
Compare
README.md
Outdated
| ### Refresh Intellisense | ||
|
|
||
| To provide the extension with an up-to-date schema for the Terraform providers used in your configuration: | ||
|
|
||
| 1. Open a terminal and change the current working directory to your desired workspace and/or the root folder containing your Terraform files. | ||
| 1. Perform a `terraform init` from the terminal. | ||
| 1. Open VS Code in the current working directory by typing `code .` |
There was a problem hiding this comment.
FWIW the language server should be able to pick up new providers automatically whenever anything changes in .terraform, so init should actually be sufficient here - there should be no need to restart VSCode.
There was a problem hiding this comment.
This was hard to figure out. The original documentation was from when we had to run init outside the editor and I was trying to reconcile that with current experience. I'll edit this.
Co-authored-by: Radek Simko <radek.simko@gmail.com>
Co-authored-by: Radek Simko <radek.simko@gmail.com>
Co-authored-by: Daniel Banck <dbanck@users.noreply.github.com>
jpogran
force-pushed
the
update_readme
branch
from
b52e296
to
95a41b7
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
This PR updates the README with more user focused documentation about extension usage, features, troubleshooting info, an improved quick start, and more detailed workflow scenarios. The aim is to be as comprehensive and helpful as possible without going into dedicated website territory.
To do this required significantly changing the order and content of the sections. This allows us to have linkable headers that we can provide in tickets and when interacting with our community.
It also adds example screenshots of features in use. These are purposely ignored by the packaging command to save space in the VSIX. They are referenced using Markdown links that will be automatically translated by
vscewhen packaging, so will be available to internet connected clients when viewed inside the Extension pane. If there is no internet, they won't be resolvable, but that is a small price to pay for a small install size.This also includes corrected and/or updated information that replaces the following Wiki pages: