Update titles, descriptions, and page headers to comply with style gu…

…ide and optimize for SEO
hashicorp · Nov 22, 2024 · 1d941a9 · 1d941a9
1 parent a524ac7
commit 1d941a9
Show file tree

Hide file tree

Showing 53 changed files with 219 additions and 179 deletions.
diff --git a/website/docs/cdktf/api-reference/csharp/index.mdx b/website/docs/cdktf/api-reference/csharp/index.mdx
@@ -1,9 +1,11 @@
 ---
-page_title: C# API resource reference overview
-description: Learn about the API resources available in the Terraform CDK library for C#.
+title: CDKTF C# API resource reference overview
+description: >-
+  Explore API resources in the Terraform CDK library for C#, including classes,
+  constructs, enums, protocols, and structs.
 ---
 
-# C# API resource reference overview
+# C# API resource reference
 
 The C# API reference includes the following resources:
 

diff --git a/website/docs/cdktf/api-reference/go/index.mdx b/website/docs/cdktf/api-reference/go/index.mdx
@@ -1,9 +1,10 @@
 ---
-page_title: Go API resource reference overview
-description: Learn about the API resources available in the Terraform CDK library for golang.
+page_title: Go TypeScript API reference overview
+description: >-
+  Use the Terraform CDK library for Go to define your CDK for Terraform application.
 ---
 
-# Go API resource reference overview
+# CDKTF Go API reference overview
 
 The Go API reference includes the following resources:
 

diff --git a/website/docs/cdktf/api-reference/index.mdx b/website/docs/cdktf/api-reference/index.mdx
@@ -1,10 +1,12 @@
 ---
-page_title: API Reference - CDKTF Core Library
+page_title: CDKTF core library API Reference
 description: >-
-  Use the CDKTF core library with generated provider bindings to write your CDKTF program. It is available in TypeScript, Python, Java, CSharp, and Go.
+  Use the CDK for Terraform core library with generated provider bindings to
+  write your CDK for Terraform application. It is available in TypeScript,
+  Python, Java, C#, and Go.
 ---
 
-# Core Library API Reference
+# CDKTF core library API Reference
 
 The CDK for Terraform (CDKTF) core library lets you define infrastructure resources using familiar programming languages. CDKTF translates the API into the following supported languages.
 

diff --git a/website/docs/cdktf/api-reference/java/index.mdx b/website/docs/cdktf/api-reference/java/index.mdx
@@ -1,11 +1,12 @@
 ---
-page_title: Java API resource reference overview
-description: Learn about the API resources available in the Terraform CDK library for Java.
+page_title: CDKTF Java API reference overview
+description: >-
+  Use the Terraform CDK library for Java to define your CDK for Terraform application.
 ---
 
-# Java API resource reference overview
+# CDKTF Java API reference overview
 
-The Java API reference includes the following resources:
+The CDK for Terraform Java API includes the following:
 
 - [Classes](/terraform/cdktf/api-reference/java/classes)
 - [Constructs](/terraform/cdktf/api-reference/java/constructs)

diff --git a/website/docs/cdktf/api-reference/provider.mdx b/website/docs/cdktf/api-reference/provider.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: API Reference - CDKTF Provider Bindings
+page_title: CDKTF API Reference provider bindings
 description: >-
   The CDKTF provider bindings are used to make your CDKTF application run with different Terraform providers
 ---

diff --git a/website/docs/cdktf/api-reference/python/index.mdx b/website/docs/cdktf/api-reference/python/index.mdx
@@ -1,9 +1,10 @@
 ---
-page_title: Python API resource reference overview
-description: Learn about the API resources available in the Terraform CDK library for Python.
+page_title: CDKTF Python API reference overview
+description: >-
+  Use the Terraform CDK library for Python to define your CDK for Terraform application.
 ---
 
-# Python API resource reference overview
+# CDKTF Python API reference overview
 
 The Python API reference includes the following resources:
 

diff --git a/website/docs/cdktf/api-reference/typescript/index.mdx b/website/docs/cdktf/api-reference/typescript/index.mdx
@@ -1,11 +1,12 @@
 ---
-page_title: Typescript API resource reference overview
-description: Learn about the API resources available in the Terraform CDK library for Typescript.
+page_title: CDKTF TypeScript API reference overview
+description: >-
+  Use the Terraform CDK library for TypeScript to define your CDK for Terraform application.
 ---
 
-# Typescript API resource reference overview
+# CDKTF TypeScript API reference overview
 
-The Typescript API reference includes the following resources:
+The TypeScript API reference includes the following resources:
 
 - [Classes](/terraform/cdktf/api-reference/typescript/classes)
 - [Constructs](/terraform/cdktf/api-reference/typescript/constructs)

diff --git a/website/docs/cdktf/cli-reference/cli-configuration.mdx b/website/docs/cdktf/cli-reference/cli-configuration.mdx
@@ -1,9 +1,10 @@
 ---
-page_title: CLI Configuration - CDK for Terraform
-description: Install and configure the CDKTF Command Line Interface.
+page_title: CLI configuration
+description: >-
+  Install and configure the CDK for Terraform Command Line Interface (CLI).
 ---
 
-# CLI Configuration
+# CLI configuration
 
 The CDK for Terraform (CDKTF) CLI allows you to initialize a new CDKTF project, adjust project settings, synthesize your infrastructure into Terraform configuration files, deploy your CDKTF application, and more. You can also use some Terraform CLI commands like `terraform apply` and `terraform destroy` directly, but we recommend using the available [`cdktf cli` commands](/terraform/cdktf/cli-reference/commands) where possible.
 

diff --git a/website/docs/cdktf/cli-reference/commands.mdx b/website/docs/cdktf/cli-reference/commands.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: CLI Commands - CDK for Terraform
+page_title: CLI commands reference
 description: >-
-  Use the CLI to initialize a new project, deploy your CDKTF app, generate
-  Terraform configuration files, and more.
+  Use the CDK for Terraform CLI to initialize a new project, deploy your CDKTF
+  application, generate Terraform configuration files, and other operations.
 ---
 
-# CLI Commands
+# CLI commands
 
 The CDK for Terraform CLI has the following commands:
 

diff --git a/website/docs/cdktf/community.mdx b/website/docs/cdktf/community.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: CDKTF Community - CDK for Terraform
+page_title: The CDK for Terraform community
 description: >-
-  Resources to help you contribute to the codebase, submit issues, ask
-  questions, and see our roadmap.
+  The CDKTF community includes a collection of resources to help you contribute to the
+  codebase, submit issues, ask questions, and see our roadmap.
 ---
 
-# Community
+# The CDK for Terraform community
 
 CDK for Terraform (CDKTF) is under active development, and we would love your feedback and direct contributions to help guide the project.
 

diff --git a/website/docs/cdktf/concepts/aspects.mdx b/website/docs/cdktf/concepts/aspects.mdx
@@ -1,12 +1,11 @@
 ---
-page_title: Aspects - CDK for Terraform
+page_title: Aspects
 description: >-
-  Aspects apply an operation to all constructs in a given scope. You can use
-  them for mutation (e.g., add resource tags) and validation (e.g., check
-  encryption).
+  Use CDK for Terraform aspects to mutate and validate data. Apply an operation
+  to all CDKTF constructs in a given scope.
 ---
 
-# Aspects
+# Use CDK for Terraform aspects
 
 Aspects allow you to apply an operation to all constructs within a given scope. You may want to use them in your CDK for Terraform (CDKTF) application to mutate elements (e.g., add tags to cloud resources) or for validation (e.g., ensure all S3 Buckets are encrypted).
 

diff --git a/website/docs/cdktf/concepts/assets.mdx b/website/docs/cdktf/concepts/assets.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Assets - CDK for Terraform
+title: Manage assets with CDKTF
 description: >-
-  Asset constructs manage assets for resources that need them, such as
-  template_file, S3 bucket objects, or Lambda function archive files.
+  Use CDK for Terraform's asset constructs to manage resources such as
+  template files, S3 bucket objects, and Lambda function archives.
 ---
 
-# Assets
+# Manage assets with CDKTF
 
 In CDK for Terraform (CDKTF) v0.4+, asset constructs can manage assets for resources that need them, such as template_file, S3 bucket objects, or Lambda function archive files. You can use Terraform assets to move existing files or directories into your CDKTF application so that you can use them in resource definitions.
 

diff --git a/website/docs/cdktf/concepts/cdktf-architecture.mdx b/website/docs/cdktf/concepts/cdktf-architecture.mdx
@@ -1,6 +1,10 @@
 ---
-page_title: CDKTF Architecture - CDK for Terraform
-description: Key CDK for Terraform components and application structure.
+page_title: CDKTF Architecture
+description: >-
+  Learn how CDK for Terraform allows you to write applications that manage your
+  infrastructure with Terraform. Use CDKTF libraries to write your
+  infrastructure management applications in TypeScript, Python, Java, C#, and
+  Go.
 ---
 
 # Architecture

diff --git a/website/docs/cdktf/concepts/constructs.mdx b/website/docs/cdktf/concepts/constructs.mdx
@@ -1,14 +1,11 @@
 ---
-page_title: Constructs - CDK for Terraform
+page_title: Constructs
 description: >-
-  “Constructs are classes that allow you to reuse existing configurations. Learn
-  about using constructs in your CDKTF application and how to publish custom
-  constructs.”
+  Use CDK for Terraform constructs to create classes that define a set of
+  infrastructure that you can reuse and compose with other constructs.
 ---
 
-# Constructs
-
-## What is a construct?
+# CDK for Terraform constructs
 
 In CDKTF, a construct is a building block that can represent anything from a single resource to a complex subset of your infrastructure. Each CDKTF program can be thought of as a tree being made up of constructs.
 

diff --git a/website/docs/cdktf/concepts/data-sources.mdx b/website/docs/cdktf/concepts/data-sources.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Data Sources - CDK for Terraform
+page_title: Data sources
 description: >-
-  Use data sources to allow Terraform to use external data, function output, and
-  data from other configurations.
+  Use data sources to allow CDK for Terraform to fetch external data, function
+  output, and data from other configurations.
 ---
 
-# Data Sources
+# CDK for Terraform data sources
 
 [Terraform data sources](/terraform/language/data-sources) fetch information from external APIs and from other Terraform configurations. For example, you may want to import disk image IDs from a cloud provider or share data between configurations for different parts of your infrastructure.
 

diff --git a/website/docs/cdktf/concepts/functions.mdx b/website/docs/cdktf/concepts/functions.mdx
@@ -1,9 +1,11 @@
 ---
-page_title: Functions - CDK for Terraform
-description: Learn when to use built-in Terraform functions to transform or combine values.
+page_title: Functions
+description: >-
+  Use built-in Terraform functions and CDK for Terraform helper functions to
+  combine and transform values in your infrastructure configurations.
 ---
 
-# Functions
+# Use Terraform functions in CDKTF
 
 Terraform provides a set of built-in functions that transform and combine values within Terraform configurations. The [Terraform function documentation](/terraform/language/functions) contains a complete list. You can also use your editor autocompletion on the `Fn` object to find available options.
 

diff --git a/website/docs/cdktf/concepts/hcl-interoperability.mdx b/website/docs/cdktf/concepts/hcl-interoperability.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: HCL Interoperability - CDK for Terraform
+title: HCL interoperability
 description: >-
-  Use configurations written in HCL and configurations written in CDK for
-  Terraform together to define and provision infrastructure.
+  Use Terraform configuration written in HCL with CDK for Terraform applications
+  to define and provision infrastructure.
 ---
 
-# HCL Interoperability
+# HCL interoperability
 
 Terraform requires infrastructure configuration files written in either [HashiCorp Configuration Language (HCL)](/terraform/language/syntax/configuration) or JSON syntax. CDK for Terraform (CDKTF) works by translating configurations defined in an imperative programming language to JSON configuration files for Terraform.
 Starting from version 0.20, CDKTF can also generate Terraform HCL as output by setting the `--hcl` flag when running `cdktf synth`.

diff --git a/website/docs/cdktf/concepts/iterators.mdx b/website/docs/cdktf/concepts/iterators.mdx
@@ -1,10 +1,11 @@
 ---
-page_title: Iterators - CDK for Terraform
+title: Iterators
 description: >-
-  Iterators let you loop over a collection of values that are only available at runtime.
+  Use iterators in CDK for Terraform to loop over dynamic data and create
+  multiple resources based on runtime information.
 ---
 
-# Iterators
+# Iterators in CDK for Terraform
 
 Iterators let you loop over a collection of values. You can use them to create multiple resources of the same type based on dynamic data that is only known at runtime.
 

diff --git a/website/docs/cdktf/concepts/modules.mdx b/website/docs/cdktf/concepts/modules.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Modules - CDK for Terraform
+page_title: Modules
 description: >-
-  Use both public and private modules in your CDKTF application to reuse
-  existing configurations.
+  Use both public and private Terraform modules in your CDK for Terraform
+  application to use composable .
 ---
 
-# Modules
+# CDK for Terraform modules
 
 A [Terraform module](/terraform/language/modules) is a single directory that contains one or more configuration files.
 

diff --git a/website/docs/cdktf/concepts/providers.mdx b/website/docs/cdktf/concepts/providers.mdx
@@ -1,11 +1,12 @@
 ---
-page_title: Providers - CDK for Terraform
+page_title: Providers
 description: >-
-  Providers allow Terraform to communicate with external APIs. Learn to define
-  providers in a CDK for Terraform application.
+  Use Terraform providers in your CDK for Terraform application to communicate
+  with external APIs. Learn how to install and use Terraform providers in
+  TypeScript, Python, Java, C#, and Go.
 ---
 
-# Providers
+# CDK for Terraform providers
 
 A [provider](/terraform/language/providers) is a plugin that lets Terraform manage an external API. In your CDK for Terraform (CDKTF) application, you use your preferred programming language to define the [resources](/terraform/cdktf/concepts/resources) you want Terraform to manage on one or more providers.
 

diff --git a/website/docs/cdktf/concepts/remote-backends.mdx b/website/docs/cdktf/concepts/remote-backends.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Remote Backends - CDK for Terraform
+title: Remote backends
 description: >-
-  Configure a remote backend where Terraform can store infrastructure state
-  files remotely.
+  Configure remote backends in CDK for Terraform to store infrastructure state
+  files remotely, including HCP Terraform and other supported backends.
 ---
 
-# Remote Backends
+# Remote backends in CDK for Terraform
 
 Terraform stores [state](/terraform/language/state) about managed infrastructure to map real-world resources to the configuration, keep track of metadata, and improve performance. Terraform stores this state in a local file by default, but you can also use a Terraform [remote backend](/terraform/language/settings/backends/remote) to store state remotely.
 

diff --git a/website/docs/cdktf/concepts/resources.mdx b/website/docs/cdktf/concepts/resources.mdx
@@ -1,10 +1,11 @@
 ---
-page_title: Resources - CDK for Terraform
+page_title: Resources
 description: >-
-  Resources describe one or more infrastructure objects, like virtual networks, compute instances, and DNS records. Define resources in a CDK for Terraform application.
+  Use Terraform resources in your CDK for Terraform application to define
+  infrastructure such as virtual networks, compute instances, and DNS records.
 ---
 
-# Resources
+# CDK for Terraform Resources
 
 Resources are the most important element when defining infrastructure in CDKTF applications. Each resource describes one or more infrastructure objects, such as virtual networks, compute instances, or higher-level components such as DNS records.
 

diff --git a/website/docs/cdktf/concepts/stacks.mdx b/website/docs/cdktf/concepts/stacks.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Stacks - CDK for Terraform
+page_title: Infrastructure stacks
 description: >-
-  Use stacks to specify separate collections of infrastructure for different
-  environments, like test and production.
+  Use CDK for Terraform stacks to specify separate collections of infrastructure
+  for different environments, such as test and production.
 ---
 
-# Stacks
+# Infrastructure stacks with CDK for Terraform
 
 A stack represents a collection of infrastructure that CDK for Terraform (CDKTF) synthesizes as a dedicated Terraform configuration. Stacks allow you to separate the state management for multiple environments within an application.
 

diff --git a/website/docs/cdktf/concepts/tokens.mdx b/website/docs/cdktf/concepts/tokens.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Tokens - CDK for Terraform
+title: Tokens
 description: >-
-  Tokens allow CDK for Terraform to resolve programming language types to
-  Terraform language syntax.
+  Use CDK for Terraform tokens to resolve programming language types to
+  Terraform language syntax, including for dynamic resource attributes.
 ---
 
-# Tokens
+# Tokens in CDK for Terraform
 
 Tokens represent values that are unknown until Terraform applies your configuration. For example, names of cloud resources are only assigned upon creation.
 

diff --git a/website/docs/cdktf/concepts/variables-and-outputs.mdx b/website/docs/cdktf/concepts/variables-and-outputs.mdx
@@ -1,8 +1,8 @@
 ---
-page_title: Variables and Outputs - CDK for Terraform
+page_title: Variables and Outputs
 description: >-
-  Input variables, local values, and output values allow you to request and
-  publish named values.
+  Use input variables, local values, and output values to input and output data
+  from your CDK for Terraform application.
 ---
 
 # Variables and Outputs

diff --git a/website/docs/cdktf/create-and-deploy/aws-adapter.mdx b/website/docs/cdktf/create-and-deploy/aws-adapter.mdx
@@ -1,9 +1,10 @@
 ---
-page_title: "[technical preview] AWS Adapter - CDK for Terraform"
-description: "[technical preview] Use AWS CDK (v2) constructs in CDK for Terraform projects."
+page_title: AWS adapter
+description: >-
+  Use AWS CDK (v2) constructs in your CDK for Terraform projects.
 ---
 
-# \[technical preview] AWS Adapter
+# CDK for Terraform AWS adapter
 
 -> **Note:** The AWS Adapter is a technical preview and not ready for production usage. Its API is not stable and things might break unexpectedly.