Skip to content

Update run task timeout explanation #479

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

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

Conversation

glennsarti
Copy link

@glennsarti glennsarti commented Jun 11, 2025

What and Why

The Run Task timeout behaviour has now changed from a fixed 10 minutes to
"No progress update in the last 10 minutes, to a maximum runtime of 60 minutes"

This commit updates the TFC docs to reflect this.


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.

@glennsarti glennsarti force-pushed the gs/update-run-task-timeout branch from 55bf491 to 5b232a1 Compare June 11, 2025 02:10
Copy link

github-actions bot commented Jun 11, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Jun 13 01:57:59 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Jun 13 01:53:00 UTC 2025

@glennsarti glennsarti changed the title Gs/update run task timeout Update run task timeout explanation Jun 11, 2025
@glennsarti glennsarti marked this pull request as ready for review June 11, 2025 02:12
@glennsarti glennsarti requested a review from a team as a code owner June 11, 2025 02:12
@glennsarti glennsarti self-assigned this Jun 11, 2025
@glennsarti
Copy link
Author

Ping @rkoron007 as I believe you're still my docs reviewer for HCP TF Run Tasks stuff.

Copy link

github-actions bot commented Jun 11, 2025

Broken Link Checker

No broken links found! 🎉

Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few suggestions

@glennsarti glennsarti force-pushed the gs/update-run-task-timeout branch from 0c454fe to 2e98bdb Compare June 12, 2025 01:24
@glennsarti
Copy link
Author

@trujillo-adam All suggestions commited. Thankyou for those!

@glennsarti
Copy link
Author

Hrmmm.... weird error happening.... @trujillo-adam any idea what's causing this?

Errors in content/terraform-docs-common/docs/cloud-docs/integrations/run-tasks/index.mdx
[404] https://unified-docs-frontend-preview-b09eom20v-hashicorp.vercel.app/hcp/docs/packer/manage-image-use/terraform-cloud-run-tasks | Network error: Not Found

@rkoron007
Copy link
Contributor

rkoron007 commented Jun 12, 2025

@glennsarti So, we now have a link checker! 🎉 The error is saying that in the /terraform-docs-common/docs/cloud-docs/integrations/run-tasks/index.mdx file a link to /hcp/docs/packer/manage-image-use/terraform-cloud-run-tasks is broken. Checking dev dot, it looks like it's a valid link, so this is probably a timeout issue (sometimes happens with redirected links). The link checker isn't perfect, but oh my gosh I'm still so happy to finally have one.

Anyways, this is all good to go!

glennsarti and others added 6 commits June 13, 2025 09:36
This commit just updates the table whitespace in the markdown file. No change to docs rendering.
The Run Task timeout behaviour has now changed from a fixed 10 minutes to
"No progress update in the last 10 minutes, to a maximum runtime of 60 minutes"

This commit updates the TFC docs to reflect this.
…-tasks/index.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
…ks/run-tasks-integration.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
…-tasks/index.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
@glennsarti glennsarti force-pushed the gs/update-run-task-timeout branch from 2e98bdb to f55551e Compare June 13, 2025 01:39
@glennsarti
Copy link
Author

@rkoron007 I had to change the link in the doc to not use the redirected link. No matter what I did the link checker would fail. Unfortunatley the 404 means it's not a timeout, it's that the end link doesn exist and since I didn't change anything on that side I have no idea how else to resolve the problem.

@rkoron007
Copy link
Contributor

@glennsarti But the link checker says there are no broken links! You fixed it!

Broken Link Checker

No broken links found! 🎉

@glennsarti
Copy link
Author

@rkoron007 or @trujillo-adam would appreciate a ✅ so I can merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants