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

plugin/framework: Initial State Upgrade information #2255

Merged
merged 1 commit into from
Apr 28, 2022

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Apr 21, 2022

What

  • Created /plugin/framework/resources/state-upgrade page and add to plugin navigation
  • Update /plugin/framework/resources for UpgradeState method
  • Update /plugin/which-sdk page to remove missing feature

Why

Reference: hashicorp/terraform-plugin-framework#42
Reference: hashicorp/terraform-plugin-framework#292

The next release of terraform-plugin-framework will support provider defined managed resource state upgrades, which is a major missing feature for parity with SDKv2.

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

Content

  • Redirects have been added for moved, renamed, or deleted pages.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • 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.
  • 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.

@bflad bflad added new docs Something that requires new documentation to be written plugin Docs for extending terraform and writing providers labels Apr 21, 2022
@bflad bflad requested a review from a team as a code owner April 21, 2022 18:54
@vercel
Copy link

vercel bot commented Apr 21, 2022

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

Name Status Preview Updated
terraform-website ✅ Ready (Inspect) Visit Preview Apr 21, 2022 at 6:56PM (UTC)

Copy link
Contributor

@detro detro left a comment

Choose a reason for hiding this comment

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

This goes well beyond the level of details I was expecting: it provides full examples for the cases where people provide previous schema and when they don't.

🎩

@bflad bflad self-assigned this Apr 25, 2022
@bflad
Copy link
Contributor Author

bflad commented Apr 25, 2022

Will merge once this functionality is released. 👍

@bflad bflad merged commit 0d079da into master Apr 28, 2022
@bflad bflad deleted the bflad-plugin-framework-UpgradeResourceState branch April 28, 2022 16:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
new docs Something that requires new documentation to be written plugin Docs for extending terraform and writing providers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants