From e1c25337c721dcb1dcf1ef29df6a869474d4f75c Mon Sep 17 00:00:00 2001 From: Pam Selle <204372+pselle@users.noreply.github.com> Date: Thu, 18 Feb 2021 12:23:04 -0500 Subject: [PATCH] Delete readme, add doc.go to helper/schema Remove the README that had old user-facing information, replacing it with a doc.go that describes the package and points to the plugin SDK for external consumers. --- internal/legacy/helper/schema/README.md | 11 ----------- internal/legacy/helper/schema/doc.go | 5 +++++ 2 files changed, 5 insertions(+), 11 deletions(-) delete mode 100644 internal/legacy/helper/schema/README.md create mode 100644 internal/legacy/helper/schema/doc.go diff --git a/internal/legacy/helper/schema/README.md b/internal/legacy/helper/schema/README.md deleted file mode 100644 index 28c83628e..000000000 --- a/internal/legacy/helper/schema/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Terraform Helper Lib: schema - -The `schema` package provides a high-level interface for writing resource -providers for Terraform. - -If you're writing a resource provider, we recommend you use this package. - -The interface exposed by this package is much friendlier than trying to -write to the Terraform API directly. The core Terraform API is low-level -and built for maximum flexibility and control, whereas this library is built -as a framework around that to more easily write common providers. diff --git a/internal/legacy/helper/schema/doc.go b/internal/legacy/helper/schema/doc.go new file mode 100644 index 000000000..f1a0e86da --- /dev/null +++ b/internal/legacy/helper/schema/doc.go @@ -0,0 +1,5 @@ +// Package schema is a legacy package that used to represent the SDK, which is now its own +// library external to Terraform Core https://github.com/hashicorp/terraform-plugin-sdk +// Some of it is still used by Terraform's remote state backends, but this entire +// package should be removed in the future. +package schema