Skip to content

Commit 9207c3b

Browse files
robin-norwoodaustinvalle
robin-norwood
and
austinvalle
authored
Update docs titles and descriptions for SEO and style guide (#1066)
* Update docs titles and descriptions for SEO and style guide * Update code-walkthrough.mdx * Update accessing-values.mdx * Update testing.mdx * Update configure.mdx * Update index.mdx * Update timeouts.mdx * Update validate-configuration.mdx * Update diagnostics.mdx * Update close.mdx * Update configure.mdx * Update index.mdx * Update open.mdx * Update renew.mdx * Update validate-configuration.mdx * Update documentation.mdx * Update errors.mdx * Update implementation.mdx * Update index.mdx * Update bool.mdx * Update dynamic.mdx * Update float32.mdx * Update float64.mdx * Update index.mdx * Use offocial name for framework * Updates from review feedback * Update website/docs/plugin/framework/handling-data/terraform-concepts.mdx Co-authored-by: Austin Valle <[email protected]> --------- Co-authored-by: Austin Valle <[email protected]>
1 parent e6e64e1 commit 9207c3b

File tree

134 files changed

+508
-420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+508
-420
lines changed

‎website/docs/plugin/framework/acctests.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
page_title: 'Plugin Development - Framework: Acceptance Tests'
2+
page_title: Acceptance tests
33
description: >-
4-
How to write acceptance tests for providers built on the framework. Acceptance
5-
tests imitate applying configuration files.
4+
Learn how to write acceptance tests for providers built on the framework.
5+
Acceptance tests help ensure your provider works as expected by imitating
6+
Terraform operations.
67
---
78

8-
# Acceptance Tests
9+
# Acceptance tests
910

1011
Implement provider resource and data source acceptance tests with the [terraform-plugin-testing module](/terraform/plugin/testing). These tests are designed to execute Terraform commands against real Terraform configurations, simulating practitioner experiences with creating, refreshing, updating, and deleting infrastructure.
1112

‎website/docs/plugin/framework/data-sources/configure.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
page_title: 'Plugin Development - Framework: Configure Data Sources'
2+
page_title: Configure data sources
33
description: >-
4-
How to configure data sources with provider data or clients in the provider development framework.
4+
Learn how to configure data sources with provider data or clients in the
5+
Terraform plugin framework.
56
---
67

7-
# Configure Data Sources
8+
# Configure data sources
89

910
[Data sources](/terraform/plugin/framework/data-sources) may require provider-level data or remote system clients to operate correctly. The framework supports the ability to configure this data and/or clients once within the provider, then pass that information to data sources by adding the `Configure` method.
1011

‎website/docs/plugin/framework/data-sources/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
page_title: 'Plugin Development - Framework: Data Sources'
2+
page_title: Data sources
33
description: >-
4-
How to build data sources in the provider development framework. Data sources
5-
allow Terraform to reference external data.
4+
Data sources allow Terraform to reference external data. Learn how the
5+
framework can help you implement data sources.
66
---
77

8-
# Data Sources
8+
# Data sources
99

1010
[Data sources](/terraform/language/data-sources) are an abstraction that allow Terraform to reference external data. Unlike [managed resources](/terraform/language/resources), Terraform does not manage the lifecycle of the resource or data. Data sources are intended to have no side-effects.
1111

‎website/docs/plugin/framework/data-sources/timeouts.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
page_title: 'Plugin Development - Framework: Timeouts'
2+
page_title: Timeouts
33
description: >-
4-
How to use timeouts with the provider development framework.
4+
Learn how to implement timeouts with the Terraform plugin framework.
55
---
66

77
# Timeouts

‎website/docs/plugin/framework/data-sources/validate-configuration.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
page_title: 'Plugin Development - Framework: Validate Data Source Configurations'
2+
page_title: Validate data source configurations
33
description: >-
4-
How to validate data source configurations with the provider development framework.
4+
Learn how to validate data source configurations with the Terraform plugin
5+
framework.
56
---
67

7-
# Validate Configuration
8+
# Validate data source configurations
89

910
[Data sources](/terraform/plugin/framework/data-sources) support validating an entire practitioner configuration in either declarative or imperative logic. Feedback, such as required syntax or acceptable combinations of values, is returned via [diagnostics](/terraform/plugin/framework/diagnostics).
1011

‎website/docs/plugin/framework/debugging.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
page_title: Plugin Development - Debugging Framework Providers
3-
description: How to implement debugger support in Framework Terraform providers.
2+
page_title: Debugging framework providers
3+
description: >-
4+
Learn how to implement debugger support in framework Terraform providers.
45
---
56

6-
# Debugging Framework Providers
7+
# Debugging framework Providers
78

89
This page contains implementation details for inspecting runtime information of a Terraform provider developed with Framework via a debugger tool by adjusting the [provider server](/terraform/plugin/framework/provider-servers) implementation. 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.
910

‎website/docs/plugin/framework/deprecations.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2-
page_title: 'Plugin Development - Deprecations, Removals, and Renames Best Practices'
3-
description: 'Recommendations for deprecations, removals, and renames.'
2+
page_title: Deprecations, removals, and renames
3+
description:
4+
Use the following recommendations to handle deprecations, removals, and
5+
renames in framework providers.
46
---
57

6-
# Deprecations, Removals, and Renames
8+
# Deprecations, removals, and renames
79

810
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.
911

‎website/docs/plugin/framework/diagnostics.mdx‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
page_title: 'Plugin Development - Framework: Errors and Warnings'
3-
description: |-
4-
How to return errors and warnings from the Terraform provider development
5-
framework.
2+
page_title: Errors and warnings
3+
description: >-
4+
Learn how to return errors and warnings from the Terraform plugin framework.
65
---
76

8-
# Returning Errors and Warnings
7+
# Returning errors and warnings
98

109
Providers use `Diagnostics` to surface errors and warnings to practitioners,
1110
such as contextual messages returned from Terraform CLI at the end of

‎website/docs/plugin/framework/ephemeral-resources/close.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
page_title: 'Plugin Development - Framework: Open Ephemeral Resources'
2+
page_title: Closing ephemeral resources
33
description: >-
4-
How to implement ephemeral resource close in the provider development framework.
4+
Learn how to close ephemeral resource in the Terraform plugin framework.
55
---
66

7-
# Close Ephemeral Resources
7+
# Closing Ephemeral Resources
88

99
Close is an optional part of the Terraform lifecycle for an ephemeral resource, which is different from the [managed resource lifecycle](https://github.com/hashicorp/terraform/blob/main/docs/resource-instance-change-lifecycle.md). During any Terraform operation (like [`terraform plan`](/terraform/cli/commands/plan) or [`terraform apply`](/terraform/cli/commands/apply)), when an ephemeral resource's data is needed, Terraform initially retrieves that data with the [`Open`](/terraform/plugin/framework/ephemeral-resources/open) lifecycle handler. Once the ephemeral resource data is no longer needed, Terraform calls the provider `CloseEphemeralResource` RPC, in which the framework calls the [`ephemeral.EphemeralResourceWithClose` interface `Close` method](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework/ephemeral#EphemeralResourceWithClose). The request contains any `Private` data set in the latest `Open` or `Renew` call.
1010

‎website/docs/plugin/framework/ephemeral-resources/configure.mdx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
page_title: 'Plugin Development - Framework: Configure Ephemeral Resources'
2+
page_title: Configuring ephemeral resources
33
description: >-
4-
How to configure ephemeral resources with provider data or clients in the provider development framework.
4+
Learn how to configure ephemeral resources with provider data or clients in
5+
the Terraform plugin framework.
56
---
67

7-
# Configure Ephemeral Resources
8+
# Configuring ephemeral resources
89

910
[Ephemeral Resources](/terraform/plugin/framework/ephemeral-resources) may require provider-level data or remote system clients to operate correctly. The framework supports the ability to configure this data and/or clients once within the provider, then pass that information to ephemeral resources by adding the `Configure` method.
1011

0 commit comments

Comments
 (0)