Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Add a redirect to the dependency-lock#checksum-verification documentation. #2372

Merged
merged 3 commits into from Jul 19, 2022

Conversation

liamcervante
Copy link
Member

@liamcervante liamcervante commented Jul 13, 2022

What

Add a redirect to the dependency-lock#checksum-verification documentation.

Why

This will be referenced from the terraform CLI as it contains information about workarounds for a particular edge case in the terraform lock file lifecycle that is too difficult to explain in an error message.

We will use the redirect to make sure that even if the documentation is updated/moved older versions of terraform will can be retroactively updated to point to the wherever the new documentation is.

The original pull request that led to this decision is here.

Screenshots

N/A


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. tfc).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added for moved, renamed, or deleted pages.
  • N/A Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • N/A Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • N/A Pages with related content are updated and link to this content when appropriate.
  • N/A New pages have metadata (page name and description) at the top.
  • N/A 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.
  • N/A New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • N/A 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.
  • N/A I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@vercel
Copy link

vercel bot commented Jul 13, 2022

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

Name Status Preview Updated
terraform-website ✅ Ready (Inspect) Visit Preview Jul 19, 2022 at 9:32AM (UTC)

@liamcervante liamcervante marked this pull request as draft July 13, 2022 08:23
@liamcervante liamcervante marked this pull request as ready for review July 13, 2022 08:30
@liamcervante liamcervante changed the title Add provider-checksum-verification redirect so we can link directly f… Add a redirect to the dependency-lock#checksum-verification documentation. Jul 13, 2022
Copy link
Member

@apparentlymart apparentlymart left a comment

Choose a reason for hiding this comment

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

This seems reasonable to me.

I was going to suggest that a comment on this item explaining that it's there for Terraform CLI to link to might help future maintainers, but it doesn't seem like there's precedent above for commenting particular redirects or groups of redirects to document their history, so maybe it's not so important.

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

Successfully merging this pull request may close these issues.

None yet

2 participants