docs: Updated the templates used by tfplugindocs.

northwood-labs · Dec 20, 2023 · 1c2bc3c · 1c2bc3c
1 parent 1d00129
commit 1c2bc3c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 10 deletions.
diff --git a/docs/data-sources/str_camel.md b/docs/data-sources/str_camel.md
@@ -4,10 +4,9 @@ page_title: "corefunc_str_camel Data Source - corefunc"
 subcategory: ""
 description: |-
   Converts a string to camelCase, removing any non-alphanumeric characters.
-      -> Some acronyms are maintained as uppercase. See
-      [caps: pkg-variables](https://pkg.go.dev/github.com/chanced/caps#pkg-variables) for a complete list.
-
-      Maps to the [`corefunc.StrCamel()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/corefunc#StrCamel) Go method, which can be used in [Terratest](https://terratest.gruntwork.io).
+  -> Some acronyms are maintained as uppercase. See
+  [caps: pkg-variables](https://pkg.go.dev/github.com/chanced/caps#pkg-variables) for a complete list.
+  Maps to the [`corefunc.StrCamel()`](https://pkg.go.dev/github.com/northwood-labs/terraform-provider-corefunc/corefunc#StrCamel) Go method, which can be used in [Terratest](https://terratest.gruntwork.io).
 ---
 -->
 

diff --git a/docs/index.md b/docs/index.md
@@ -25,8 +25,6 @@ description: |-
 
 # Core Functions Provider
 
--> We intend to support both Terraform as well as OpenTF with this provider.
-
 Utilities that should have been Terraform _core functions_.
 
 While some of these _can_ be implemented in HCL, some of them begin to
@@ -67,12 +65,14 @@ terraform {
 provider "corefunc" {}
 ```
 
-## Updating your Terraform lockfile
+## Updating your lockfile
 
 Running `terraform init` will download the provider and update the [_Dependency Lock File_](https://developer.hashicorp.com/terraform/language/files/dependency-lock) (`.terraform.lock.hcl`) for your _current_ OS and CPU architecture. If you have a team with multiple operating systems or multiple CPU architectures, the _Dependency Lock File_ will be incomplete, and other members on the team won't be able to use it.
 
 In order to resolve this, you can use the `terraform providers lock` command to generate a _Dependency Lock File_ that is compatible with all relevant operating systems and CPU architectures.
 
+~> **NOTE:** For OpenTofu users, the `terraform` command can be replaced with `tofu`.
+
 ### Recommended matrix
 
 Per [Recommended Provider Binary Operating Systems and Architectures](https://developer.hashicorp.com/terraform/registry/providers/os-arch):
@@ -135,4 +135,6 @@ terraform providers lock \
     ;
 ```
 
+~> **NOTE:** For OpenTofu users, avoid requesting the `netbsd` platform.
+
 <!-- Preview the provider docs with the Terraform registry provider docs preview tool: https://registry.terraform.io/tools/doc-preview -->
diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -9,20 +9,20 @@ description: |-
 
 # {{ .RenderedProviderName }} Provider
 
--> We intend to support both Terraform as well as OpenTF with this provider.
-
 {{ .Description | trimspace }}
 
 ## Setting-up the provider
 
 {{ tffile "examples/provider/provider.tf" }}
 
-## Updating your Terraform lockfile
+## Updating your lockfile
 
 Running `terraform init` will download the provider and update the [_Dependency Lock File_](https://developer.hashicorp.com/terraform/language/files/dependency-lock) (`.terraform.lock.hcl`) for your _current_ OS and CPU architecture. If you have a team with multiple operating systems or multiple CPU architectures, the _Dependency Lock File_ will be incomplete, and other members on the team won't be able to use it.
 
 In order to resolve this, you can use the `terraform providers lock` command to generate a _Dependency Lock File_ that is compatible with all relevant operating systems and CPU architectures.
 
+~> **NOTE:** For OpenTofu users, the `terraform` command can be replaced with `tofu`.
+
 ### Recommended matrix
 
 Per [Recommended Provider Binary Operating Systems and Architectures](https://developer.hashicorp.com/terraform/registry/providers/os-arch):
@@ -39,4 +39,6 @@ This is the complete list of supported operating systems and architectures for t
 
 {{ codefile "shell" "examples/provider/lock-all.sh" }}
 
+~> **NOTE:** For OpenTofu users, avoid requesting the `netbsd` platform.
+
 <!-- Preview the provider docs with the Terraform registry provider docs preview tool: https://registry.terraform.io/tools/doc-preview -->