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

update force delete workspace documentation to mention the 'Latest wo… #809

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

uturunku1
Copy link
Contributor

@uturunku1 uturunku1 commented Jan 7, 2025

…rkspace state is being processed to discover resources' error

What

Update website/docs/cloud-docs/api-docs/workspaces.mdx

Why

To mention the error "Latest workspace state is being processed to discover resources, try again later", which users may stop seeing after retrying the force-delete endpoint and waiting for resources-processed to be set to true.
We mention in the State Versions API docs how to use "resources-processed" attribute to find out if resources are still being processed when the value of the attribute is false.
It'd be good to refer the users to that doc so they know that the "Latest workspace state is being processed to discover resources, try again later" error could be a temporary one while State is still processing resources.

JIRA ticket: https://hashicorp.atlassian.net/browse/TF-23222

Screenshots


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

…rkspace state is being processed to discover resources' error
Copy link

vercel bot commented Jan 7, 2025

You must have Developer access to commit code to HashiCorp on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes.

Learn more: https://vercel.com/docs/accounts/team-members-and-roles/access-roles#team-level-roles

@uturunku1 uturunku1 added documentation Improvements or additions to documentation HCP Terraform clarification labels Jan 7, 2025
Kick off vercel deployment check.
Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 10, 2025 6:16pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant