Improve Extension Documentation (#942)

This commit 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 vsce when 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: https://github.com/hashicorp/vscode-terraform/wiki/Install-a-Pre-transfer-Version https://github.com/hashicorp/vscode-terraform/wiki/Manually-Setting-the-Terraform-Executable-Path Co-authored-by: Radek Simko <radek.simko@gmail.com> Co-authored-by: Daniel Banck <dbanck@users.noreply.github.com>
hashicorp · Feb 28, 2022 · 9461f77 · 9461f77
1 parent 6d3de3e
commit 9461f77
Show file tree

Hide file tree

Showing 13 changed files with 302 additions and 66 deletions.
diff --git a/.vscodeignore b/.vscodeignore
@@ -2,6 +2,7 @@
 .vscode
 .vscode-test
 build/
+docs/
 lsp/
 node_modules/
 src/

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,6 +1,6 @@
 # Development
 
-We are an open source project on GitHub and would enjoy your contributions! Please [open a new issue](https://github.com/hashicorp/terraform-vscode-extension/issues) before working on a PR that requires significant effort. This will allow us to make sure the work is in line with the project's goals.
+We are an open source project on GitHub and would enjoy your contributions! Please [open a new issue](https://github.com/hashicorp/terraform-vscode/issues) before working on a PR that requires significant effort. This will allow us to make sure the work is in line with the project's goals.
 
 ## Building
 

diff --git a/README.md b/README.md
diff --git a/docs/code_lens.png b/docs/code_lens.png
diff --git a/docs/intellisense1.png b/docs/intellisense1.png
diff --git a/docs/intellisense2.png b/docs/intellisense2.png
diff --git a/docs/intellisense3.png b/docs/intellisense3.png
diff --git a/docs/module_calls.png b/docs/module_calls.png
diff --git a/docs/module_calls_doc_link.png b/docs/module_calls_doc_link.png
diff --git a/docs/module_providers.png b/docs/module_providers.png
diff --git a/docs/pin_version.png b/docs/pin_version.png
diff --git a/docs/pre-fill.png b/docs/pre-fill.png
diff --git a/docs/syntax.png b/docs/syntax.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     .vscode
     .vscode-test
     build/
+    docs/
     lsp/
     node_modules/
     src/
@@ Expand Down @@