Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Update workspace documentation into v1.3 #31859

Merged

Conversation

teamterraform
Copy link
Contributor

Backport

This PR is auto-generated from #31849 to be assessed for backporting due to the inclusion of the label 1.3-backport.

The below text is copied from the body of the original PR.


What

Update the workspaces documentation in the Language and CLI documentation sets. Specifically this PR makes the following changes:

  • Pulls out the majority of the "How workspaces work" content from the language docs and puts it all together in the CLI documentation. I have added links on the language page to the CLI docs where users can find more information.
  • Removes version information about very old Terraform versions from the language documentation. We have versioned docs now, so this seems unnecessary. We're also on Terraform v1.3, which is very far removed from v0.9 that the note is referring to.
  • Adds headers to help break up long blocks of content and help users better find useful information.
  • Clarifies when users should and should not use workspaces to manage multiple groups of infrastructure. Specifically, it appears that this is not appropriate when multiple sets of infrastructure need strong separation - access credentials, etc. Because workspaces within a working directory use the same backend, this type of separation is not possible with workspaces alone.
  • Tries to make the content as short and concise as possible. Also revises it to adhere to style conventions.

Why

Users are understandably confused by the fact that we currently talk about how you can use workspaces for deployments in multiple environments but then explicitly say that this is not a recommended pattern for some deployments. It's pretty hard to understand right now what's recommended and when practitioners should be using workspaces for multiple sets of infrastructure.

Screenshots

Language Workspaces Page

Screen Shot 2022-09-22 at 7 08 55 PM

CLI Workspaces Page

Screen Shot 2022-09-23 at 4 32 57 PM


@teamterraform teamterraform force-pushed the backport/workspaces-confusion-fixes/secondly-huge-titmouse branch from ebe95bc to ca03369 Compare September 23, 2022 21:47
@teamterraform teamterraform force-pushed the backport/workspaces-confusion-fixes/secondly-huge-titmouse branch from 5d342b9 to 3d0bbe5 Compare September 23, 2022 21:47
@laurapacilio laurapacilio merged commit 4205702 into v1.3 Sep 23, 2022
@github-actions
Copy link

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

@github-actions
Copy link

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 contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants