Skip to content

Commit e492918

Browse files
Add comments for UDR migration (#1440)
1 parent 3c4ee10 commit e492918

30 files changed

+90
-0
lines changed

website/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Terraform Documentation
22

3+
> [!IMPORTANT]
4+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
5+
36
This directory contains the portions of [the Terraform website][terraform.io] that pertain to the Terraform Plugin SDK.
47

58
The files in this directory are intended to be used in conjunction with

website/docs/plugin/sdkv2/best-practices/deprecations.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: 'Plugin Development - SDKv2 Deprecations, Removals, and Renames Best
33
description: 'Recommendations for deprecations, removals, and renames.'
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Deprecations, Removals, and Renames
710

811
Terraform is trusted for managing many facets of infrastructure across many organizations. Part of that trust is due to consistent versioning guidelines and setting expectations for various levels of upgrades. Ensuring backwards compatibility for all patch and minor releases, potentially in concert with any upcoming major changes, is recommended and supported by the Terraform development framework. This allows operators to iteratively update their Terraform configurations rather than require massive refactoring.

website/docs/plugin/sdkv2/best-practices/detecting-drift.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
infrastructure has changed.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
11+
912
# Detecting Drift
1013

1114
One of the core challenges of infrastructure as code is keeping an up-to-date

website/docs/plugin/sdkv2/best-practices/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: >-
44
Patterns that ensure a consistent user experience, including deprecation, beta features, and detecting drift.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
9+
710
<Highlight>
811

912
This best practices section only contains guidance for plugins built with [Terraform Plugin SDK](/terraform/plugin/sdkv2). More generic best practices that apply to both SDK and [Terraform Plugin Framework](/terraform/plugin/framework) can be found in the [Plugin Development Best Practices](/terraform/plugin/best-practices) section.

website/docs/plugin/sdkv2/debugging.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Plugin Development - Debugging SDKv2 Providers
33
description: How to implement debugger support in SDKv2 Terraform providers.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Debugging SDKv2 Providers
710

811
This page contains implementation details for inspecting runtime information of a Terraform provider developed with SDKv2 via a debugger tool. Review the top level [Debugging](/terraform/plugin/debugging) page for information pertaining to the overall Terraform provider debugging process and other inspection options, such as log-based debugging.

website/docs/plugin/sdkv2/guides/terraform-0.12-compatibility.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ description: |-
55
codebases.
66
---
77

8+
> [!IMPORTANT]
9+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
10+
811
# Terraform 0.12 Compatibility for Providers
912

1013
Terraform 0.12 introduced a new type system for the Terraform language, and

website/docs/plugin/sdkv2/guides/v1-upgrade-guide.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Terraform Plugin SDK
33
description: Official standalone SDK for Terraform plugin development
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Terraform Plugin SDK
710

811
As of September 2019, Terraform provider developers importing the Go module `github.com/hashicorp/terraform`, known as Terraform Core, should switch to `github.com/hashicorp/terraform-plugin-sdk`, the Terraform Plugin SDK, instead.

website/docs/plugin/sdkv2/guides/v2-upgrade-guide.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Terraform Plugin SDK v2 Upgrade Guide
33
description: Upgrade guide for version 2 of the Terraform Plugin SDK.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Terraform Plugin SDK v2 Upgrade Guide
710

811
Version 2.0.0 of the Terraform Plugin SDK is a major release and includes some

website/docs/plugin/sdkv2/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: 'Home - Plugin Development: SDKv2'
33
description: Maintain plugins built on the legacy SDK.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Terraform Plugin SDKv2
710

811
Terraform Plugin SDKv2 is a way to maintain Terraform Plugins on [protocol version 5](/terraform/plugin/terraform-plugin-protocol#protocol-version-5).

website/docs/plugin/sdkv2/logging/http-transport.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: |-
44
SDKv2 provides a helper to send all the HTTP transactions to structured logging.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
9+
710
# HTTP Transport
811

912
Terraform's public interface has included `helper/logging` [`NewTransport()`](https://github.com/hashicorp/terraform-plugin-sdk/blob/main/helper/logging/transport.go) since `v0.9.5`. This helper is an implementation of the Golang standard library [`http.RoundTripper`](https://pkg.go.dev/net/http#RoundTripper) that lets you add logging at the `DEBUG` level to your provider's HTTP transactions.

0 commit comments

Comments
 (0)