Skip to content

Commit

Permalink
Update TFC documentation (#1620)
Browse files Browse the repository at this point in the history
This updates the README for the recent TFC updates:

- Removes referencs to preview or prerelease
- Records gifs using default VS Code theme, not light
- Update login gif with correct sidebar icons
- Runs view: Shows collapsed Runs, which when expanded show plan/apply details
- Plan/Apply view: Updated to use the collapsible state to expose the plan and apply items, then clicking the button to download logs
  • Loading branch information
jpogran authored Nov 7, 2023
1 parent 039756c commit 945237d
Show file tree
Hide file tree
Showing 7 changed files with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,7 @@ The extension provides several snippets to accelerate adding Terraform code to y

Every time you have to switch away from your code, you risk losing momentum and the context about your tasks. Previously, Terraform users needed to have at least two windows open – their editor and a web page – to develop Terraform code. The editor contains all of the Terraform code they are working on, and the web page has the Terraform Cloud workspace loaded. Switching back and forth between the Terraform Cloud website and the text editor can be a frustrating and fragmented experience.

The public preview of Terraform Cloud Visual Studio Code integration improves user experience by allowing users to view workspaces directly from within Visual Studio Code. Users can view the status of current and past runs and inspect detailed logs – without ever leaving the comfort of their editor.

The new Terraform Cloud features are currently available in the pre-release version of our Terraform extension, which is the Visual Studio Code equivalent of a public beta channel. If you want to opt-in to receiving the new version in order to check out these capabilities before we roll them out to all users:

1. Bring up the Extensions view in Visual Studio Code (Ctrl+Shift+X or ⇧⌘X)
1. Search for the HashiCorp Terraform extension
1. Click on "Switch to Pre-Release Version"

![](docs/tfc/switch_to_preview.gif)

If the text on the button says "Switch to Release Version", it means the pre-release version is already installed.
The Terraform Cloud Visual Studio Code integration improves user experience by allowing users to view workspaces directly from within Visual Studio Code. Users can view the status of current and past runs and inspect detailed logs – without ever leaving the comfort of their editor.

To start using Terraform Cloud with VS Code, open the new Terraform Cloud sidebar and click "Login to Terraform Cloud". You can login using a stored token from the Terraform CLI, an existing token you provide, or open the Terraform Cloud website to generate a new token.

Expand All @@ -147,7 +137,7 @@ Selecting a workspace populates the Run view with a list of runs for that worksp

![](docs/tfc/workspace_run_view.gif)

If a Run has been Planned or Applied, you can view the raw log for each by selecting the button on each Run.
If a Run has been Planned or Applied, you can view the raw log for each by expanding the Run then selecting the 'View Raw Log' button for either the Plan or Apply.

![](docs/tfc/plan_apply_view.gif)

Expand Down
Binary file modified docs/tfc/choose_org_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/tfc/login_view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/tfc/plan_apply_view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/tfc/switch_to_preview.gif
Binary file not shown.
Binary file modified docs/tfc/workspace_run_view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/tfc/workspace_view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 945237d

Please sign in to comment.