Apply suggestions from code review

Co-authored-by: Rose M Koron <[email protected]>
hashicorp · Jan 6, 2025 · a5843ca · a5843ca
1 parent 60bba1b
commit a5843ca
Show file tree

Hide file tree

Showing 36 changed files with 58 additions and 58 deletions.
diff --git a/website/docs/cdktf/api-reference/csharp/index.mdx b/website/docs/cdktf/api-reference/csharp/index.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: CDKTF C# API resource reference overview
+page_title: CDKTF C# API resource reference
 description: >-
   Explore API resources in the Terraform CDK library for C#, including classes,
   constructs, enums, protocols, and structs.

diff --git a/website/docs/cdktf/api-reference/go/index.mdx b/website/docs/cdktf/api-reference/go/index.mdx
@@ -1,10 +1,10 @@
 ---
-page_title: Go TypeScript API reference overview
+page_title: Go TypeScript API overview
 description: >-
-  Use the Terraform CDK library for Go to define your CDK for Terraform application.
+  Use the Terraform CDK library for Go to define your CDK for Terraform.
 ---
 
-# CDKTF Go API reference overview
+# CDKTF Go API 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,12 +1,12 @@
 ---
-page_title: CDKTF core library API Reference
+page_title: CDKTF core library API reference
 description: >-
   Use the CDK for Terraform core library with generated provider bindings to
-  write your CDK for Terraform application. It is available in TypeScript,
+  write your CDK for Terraform. The CDK is available in TypeScript,
   Python, Java, C#, and Go.
 ---
 
-# CDKTF 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,10 +1,10 @@
 ---
-page_title: CDKTF Java API reference overview
+page_title: CDKTF Java API overview
 description: >-
   Use the Terraform CDK library for Java to define your CDK for Terraform application.
 ---
 
-# CDKTF Java API reference overview
+# CDKTF Java API overview
 
 The CDK for Terraform Java API includes the following:
 

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

diff --git a/website/docs/cdktf/api-reference/python/index.mdx b/website/docs/cdktf/api-reference/python/index.mdx
@@ -1,10 +1,10 @@
 ---
-page_title: CDKTF Python API reference overview
+page_title: CDKTF Python API overview
 description: >-
-  Use the Terraform CDK library for Python to define your CDK for Terraform application.
+  Use the Terraform CDK library for Python to define your CDK for Terraform.
 ---
 
-# CDKTF Python API reference overview
+# CDKTF Python API 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,10 +1,10 @@
 ---
-page_title: CDKTF TypeScript API reference overview
+page_title: CDKTF TypeScript API overview
 description: >-
-  Use the Terraform CDK library for TypeScript to define your CDK for Terraform application.
+  Use the Terraform CDK library for TypeScript to define your CDK for Terraform.
 ---
 
-# CDKTF TypeScript API reference overview
+# CDKTF TypeScript API overview
 
 The TypeScript API reference includes the following resources:
 

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 reference
+page_title: CLI commands reference for CDKTF
 description: >-
   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 reference
 
 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: The CDK for Terraform community
+page_title: The CDK community for Terraform
 description: >-
   The CDKTF community includes a collection of resources to help you contribute to the
   codebase, submit issues, ask questions, and see our roadmap.
 ---
 
-# The CDK for Terraform community
+# The CDK community for Terraform
 
 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,5 +1,5 @@
 ---
-page_title: Aspects
+page_title: Use CDK for Terraform aspects
 description: >-
   Use CDK for Terraform aspects to mutate and validate data. Apply an operation
   to all CDKTF constructs in a given scope.

diff --git a/website/docs/cdktf/concepts/assets.mdx b/website/docs/cdktf/concepts/assets.mdx
@@ -1,7 +1,7 @@
 ---
 page_title: Manage assets with CDKTF
 description: >-
-  Use CDK for Terraform's asset constructs to manage resources such as
+  Use the CDK for Terraform's asset constructs to manage resources such as
   template files, S3 bucket objects, and Lambda function archives.
 ---
 

diff --git a/website/docs/cdktf/concepts/cdktf-architecture.mdx b/website/docs/cdktf/concepts/cdktf-architecture.mdx
@@ -1,13 +1,13 @@
 ---
-page_title: CDKTF Architecture
+page_title: CDKTF architecture
 description: >-
-  Learn how CDK for Terraform allows you to write applications that manage your
+  Learn how the 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
+# CDKTF architecture
 
 This page explains the tools and processes that CDK for Terraform (CDKTF) uses to leverage the Terraform ecosystem and convert code into Terraform configuration files. It also explains the major components of a CDKTF application and how those pieces fit together.
 

diff --git a/website/docs/cdktf/concepts/constructs.mdx b/website/docs/cdktf/concepts/constructs.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Constructs
+page_title: CDK for Terraform constructs
 description: >-
   Use CDK for Terraform constructs to create classes that define a set of
   infrastructure that you can reuse and compose with other constructs.

diff --git a/website/docs/cdktf/concepts/data-sources.mdx b/website/docs/cdktf/concepts/data-sources.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Data sources
+page_title: CDK for Terraform data sources
 description: >-
   Use data sources to allow CDK for Terraform to fetch external data, function
   output, and data from other configurations.

diff --git a/website/docs/cdktf/concepts/functions.mdx b/website/docs/cdktf/concepts/functions.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Functions
+page_title: Use Terraform functions in CDKTF
 description: >-
   Use built-in Terraform functions and CDK for Terraform helper functions to
   combine and transform values in your infrastructure configurations.

diff --git a/website/docs/cdktf/concepts/hcl-interoperability.mdx b/website/docs/cdktf/concepts/hcl-interoperability.mdx
@@ -1,7 +1,7 @@
 ---
 page_title: HCL interoperability
 description: >-
-  Use Terraform configuration written in HCL with CDK for Terraform applications
+  Use Terraform configurations written in HCL with the CDK for Terraform
   to define and provision infrastructure.
 ---
 

diff --git a/website/docs/cdktf/concepts/iterators.mdx b/website/docs/cdktf/concepts/iterators.mdx
@@ -1,7 +1,7 @@
 ---
-page_title: Iterators
+page_title: Iterators in CDK for Terraform
 description: >-
-  Use iterators in CDK for Terraform to loop over dynamic data and create
+  Use iterators in the CDK for Terraform to loop over dynamic data and create
   multiple resources based on runtime information.
 ---
 

diff --git a/website/docs/cdktf/concepts/modules.mdx b/website/docs/cdktf/concepts/modules.mdx
@@ -1,8 +1,8 @@
 ---
-page_title: Modules
+page_title: CDK for Terraform modules
 description: >-
   Use both public and private Terraform modules in your CDK for Terraform
-  application to use composable .
+ to re-use Terraform configurations.
 ---
 
 # CDK for Terraform modules

diff --git a/website/docs/cdktf/concepts/providers.mdx b/website/docs/cdktf/concepts/providers.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Providers
+page_title: CDK for Terraform providers
 description: >-
   Use Terraform providers in your CDK for Terraform application to communicate
   with external APIs. Learn how to install and use Terraform providers in

diff --git a/website/docs/cdktf/concepts/remote-backends.mdx b/website/docs/cdktf/concepts/remote-backends.mdx
@@ -1,8 +1,8 @@
 ---
-page_title: Remote backends
+page_title: Remote backends in CDK for Terraform
 description: >-
   Configure remote backends in CDK for Terraform to store infrastructure state
-  files remotely, including HCP Terraform and other supported backends.
+  files remotely, including files from HCP Terraform and other supported backends.
 ---
 
 # Remote backends in CDK for Terraform

diff --git a/website/docs/cdktf/concepts/resources.mdx b/website/docs/cdktf/concepts/resources.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Resources
+page_title: CDK for Terraform resources 
 description: >-
   Use Terraform resources in your CDK for Terraform application to define
   infrastructure such as virtual networks, compute instances, and DNS records.
 ---
 
-# CDK for Terraform 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,5 +1,5 @@
 ---
-page_title: Infrastructure stacks
+page_title: Infrastructure stacks with CDK for Terraform
 description: >-
   Use CDK for Terraform stacks to specify separate collections of infrastructure
   for different environments, such as test and production.

diff --git a/website/docs/cdktf/concepts/tokens.mdx b/website/docs/cdktf/concepts/tokens.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Tokens
+page_title: Tokens in CDK for Terraform
 description: >-
   Use CDK for Terraform tokens to resolve programming language types to
   Terraform language syntax, including for dynamic resource attributes.

diff --git a/website/docs/cdktf/concepts/variables-and-outputs.mdx b/website/docs/cdktf/concepts/variables-and-outputs.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Variables and Outputs
+page_title: Variables and outputs in CDKTF
 description: >-
   Use input variables, local values, and output values to input and output data
   from your CDK for Terraform application.
 ---
 
-# Variables and Outputs
+# Variables and outputs
 
 Terraform can understand configurations written in either HashiCorp Configuration Language (HCL) syntax or JSON. Because neither of these is a programming language, Terraform has developed ways to enable users to request and publish named values. These are:
 

diff --git a/website/docs/cdktf/create-and-deploy/aws-adapter.mdx b/website/docs/cdktf/create-and-deploy/aws-adapter.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: AWS adapter
+page_title: CDK for Terraform AWS adapter
 description: >-
   Use AWS CDK (v2) constructs in your CDK for Terraform projects.
 ---

diff --git a/website/docs/cdktf/create-and-deploy/best-practices.mdx b/website/docs/cdktf/create-and-deploy/best-practices.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Best practices
+page_title: CDK for Terraform best practices
 description: >-
   Learn how to structure your CDK for Terraform projects to build robust
   applications for production use cases. Manage secrets, build constructs, and

diff --git a/website/docs/cdktf/create-and-deploy/configuration-file.mdx b/website/docs/cdktf/create-and-deploy/configuration-file.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Configuration
+page_title: CDK for Terraform configuration
 description: >-
   Use the cdktf.json file to customize your CDK for Terraform application and
   define the providers and modules to use with your application.
 ---
 
-# CDK for Terrafrom configuration
+# CDK for Terraform configuration
 
 The `cdktf.json` file is where you can supply custom configuration settings for your application and define the [providers](/terraform/cdktf/concepts/providers) and [modules](/terraform/cdktf/concepts/modules) that you want to use. When you initialize a new CDK for Terraform project with a [built-in template](/terraform/cdktf/create-and-deploy/project-setup), the template generates a basic `cdktf.json` file in your root directory that you can customize for your application. Refer to the [Project Setup documentation](/terraform/cdktf/create-and-deploy/project-setup) for more information about initializing a new project.
 

diff --git a/website/docs/cdktf/create-and-deploy/deployment-patterns.mdx b/website/docs/cdktf/create-and-deploy/deployment-patterns.mdx
@@ -1,8 +1,8 @@
 ---
-page_title: Deployment patterns
+page_title: CDK for Terraform deployment patterns
 description: >-
   Learn how to use continuous deployment patterns to provision your CDK for
-  Terrafrom applications.
+  Terraform applications.
 ---
 
 # CDK for Terraform deployment patterns

diff --git a/website/docs/cdktf/create-and-deploy/environment-variables.mdx b/website/docs/cdktf/create-and-deploy/environment-variables.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Environment variables
+page_title: CDK for Terraform environment variables
 description: >-
   Use environment variables to configure the behavior of the CDK for Terraform
   CLI.

diff --git a/website/docs/cdktf/create-and-deploy/performance.mdx b/website/docs/cdktf/create-and-deploy/performance.mdx
@@ -1,11 +1,11 @@
 ---
-page_title: Performance
+page_title: Optimize performance for CDKTF
 description: >-
   Learn how to optimize the speed of the synthesize step when you deploy your CDK
   for Terraform application.
 ---
 
-# Synthesization performance
+# Optimize performance for CDKTF
 
 The faster you can synthesize your CDKTF code, the faster you can deploy it.
 This page focuses on how to optimize your CDK for Terraform performance.

diff --git a/website/docs/cdktf/create-and-deploy/project-setup.mdx b/website/docs/cdktf/create-and-deploy/project-setup.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Project setup
+page_title: Set up a new CDK for Terraform new project
 description: >-
   Initialize a new CDK for Terraform application from a template or existing HCL
   project, and configure storage for your project's Terraform state.

diff --git a/website/docs/cdktf/create-and-deploy/remote-templates.mdx b/website/docs/cdktf/create-and-deploy/remote-templates.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Remote templates
+page_title: Remote templates with CDK for Terraform
 description: >-
   Use templates to scaffold a new CDK for Terraform project. Create and use
   custom templates for your own projects.

diff --git a/website/docs/cdktf/develop-custom-constructs/construct-design.mdx b/website/docs/cdktf/develop-custom-constructs/construct-design.mdx
@@ -1,5 +1,5 @@
 ---
-page_title: Design constructs
+page_title: Design CDKTF constructs
 description: >-
   Learn how to write CDK for Terraform construct classes to extend and customize
   configuration of your Terraform resources.

diff --git a/website/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx b/website/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx
@@ -6,7 +6,7 @@ description: >-
   private registries.
 ---
 
-# Construct publishing and distribution
+# Distribute and consume constructs
 
 Custom construct classes are reusable infrastructure configurations written in a programming language. After you [write a custom construct](/terraform/cdktf/develop-custom-constructs/construct-design), you can translate it to multiple languages and publish it for others to import and use in CDK for Terraform (CDKTF) applications.
 

diff --git a/website/docs/cdktf/release/upgrade-guide-v0-9.mdx b/website/docs/cdktf/release/upgrade-guide-v0-9.mdx
@@ -1,7 +1,7 @@
 ---
 page_title: Upgrade to CDKTF version 0.9
 description: >-
-  Learn how to upgrade to CDK for Terraform version 0.9. New provider bindings
+  Learn how to upgrade to CDK for Terraform version 0.9, which provides new provider bindings
   across all languages.
 ---
 

diff --git a/website/docs/cdktf/test/unit-tests.mdx b/website/docs/cdktf/test/unit-tests.mdx
@@ -1,10 +1,10 @@
 ---
-page_title: Unit Test CDK for Terraform
+page_title: Unit test CDK for Terraform
 description: >-
   Use assertions and snapshots to test your CDKTF application.
 ---
 
-# Unit Test CDK for Terraform
+# Unit test CDK for Terraform
 
 Testing your application can give you faster feedback cycles and guard you against unwanted changes. Testing is currently supported in Typescript with jest and compatible with any testing framework that supports assertions for all other languages.