Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Style and SEO updates #3775

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions website/docs/cdktf/api-reference/csharp/index.mdx
Original file line number Diff line number Diff line change
@@ -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#.
page_title: CDKTF C# API resource reference
description: >-
Explore API resources in the CDK for Terraform library for C#, including classes,
constructs, enums, protocols, and structs.
---

# C# API resource reference overview
# CDKTF C# API resource reference

The C# API reference includes the following resources:

Expand Down
7 changes: 4 additions & 3 deletions website/docs/cdktf/api-reference/go/index.mdx
Original file line number Diff line number Diff line change
@@ -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: CDKTF Go API overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
description: >-
Use the Terraform CDK library for Go to define your CDK for Terraform applications.
---

# Go API resource reference overview
# CDKTF Go API overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

The Go API reference includes the following resources:

Expand Down
8 changes: 5 additions & 3 deletions website/docs/cdktf/api-reference/index.mdx
Original file line number Diff line number Diff line change
@@ -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. The CDK 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.

Expand Down
9 changes: 5 additions & 4 deletions website/docs/cdktf/api-reference/java/index.mdx
Original file line number Diff line number Diff line change
@@ -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 overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
description: >-
Use the Terraform CDK library for Java to define your CDK for Terraform applications.
---

# Java API resource reference overview
# CDKTF Java API overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

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)
Expand Down
6 changes: 3 additions & 3 deletions website/docs/cdktf/api-reference/provider.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
page_title: API Reference - CDKTF Provider Bindings
page_title: CDKTF API Reference provider bindings
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
description: >-
The CDKTF provider bindings are used to make your CDKTF application run with different Terraform providers
Learn how CDK for Terraform uses provider bindings to make your CDKTF application run with different Terraform providers.
---

# Provider API Reference
# CDKTF API Reference provider bindings

A provider is a Terraform plugin that allows users to manage an external API. You can use CDK for Terraform (CDKTF) with every provider available on the [Terraform Registry](https://registry.terraform.io/browse/providers). Refer to [Providers](/terraform/cdktf/concepts/providers) for details about how to import and use providers in your CDKTF application.

Expand Down
7 changes: 4 additions & 3 deletions website/docs/cdktf/api-reference/python/index.mdx
Original file line number Diff line number Diff line change
@@ -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 overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
description: >-
Use the Terraform CDK library for Python to define your CDK for Terraform applications.
---

# Python API resource reference overview
# CDKTF Python API overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

The Python API reference includes the following resources:

Expand Down
9 changes: 5 additions & 4 deletions website/docs/cdktf/api-reference/typescript/index.mdx
Original file line number Diff line number Diff line change
@@ -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 overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
description: >-
Use the Terraform CDK library for TypeScript to define your CDK for Terraform applications.
---

# Typescript API resource reference overview
# CDKTF TypeScript API overview
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

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)
Expand Down
7 changes: 4 additions & 3 deletions website/docs/cdktf/cli-reference/cli-configuration.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/cli-reference/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: CLI Commands - CDK for Terraform
page_title: CLI command reference for CDKTF
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 command reference
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

The CDK for Terraform CLI has the following commands:

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/community.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: CDKTF Community - CDK for Terraform
page_title: The CDK for Terraform community
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
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
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved

CDK for Terraform (CDKTF) is under active development, and we would love your feedback and direct contributions to help guide the project.

Expand Down
9 changes: 4 additions & 5 deletions website/docs/cdktf/concepts/aspects.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
page_title: Aspects - CDK for Terraform
page_title: Use CDKTF 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 CDKTF 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).

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/assets.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Assets - CDK for Terraform
page_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 the 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.

Expand Down
10 changes: 7 additions & 3 deletions website/docs/cdktf/concepts/cdktf-architecture.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
page_title: CDKTF Architecture - CDK for Terraform
description: Key CDK for Terraform components and application structure.
page_title: CDKTF architecture
description: >-
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.

Expand Down
11 changes: 4 additions & 7 deletions website/docs/cdktf/concepts/constructs.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
page_title: Constructs - CDK for Terraform
page_title: CDKTF 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?
# CDKTF 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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/data-sources.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Data Sources - CDK for Terraform
page_title: CDKTF 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
# CDKTF 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.

Expand Down
8 changes: 5 additions & 3 deletions website/docs/cdktf/concepts/functions.mdx
Original file line number Diff line number Diff line change
@@ -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: 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.
---

# 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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/hcl-interoperability.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: HCL Interoperability - CDK for Terraform
page_title: HCL interoperability
description: >-
Use configurations written in HCL and configurations written in CDK for
Terraform together to define and provision infrastructure.
Use Terraform configurations written in HCL with the CDK for Terraform
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
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`.
Expand Down
7 changes: 4 additions & 3 deletions website/docs/cdktf/concepts/iterators.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
page_title: Iterators - CDK for Terraform
page_title: Iterators in CDKTF
description: >-
Iterators let you loop over a collection of values that are only available at runtime.
Use iterators in the CDK for Terraform to loop over dynamic data and create
multiple resources based on runtime information.
---

# Iterators
# Iterators in CDKTF

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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/modules.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Modules - CDK for Terraform
page_title: CDKTF 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
to re-use Terraform configurations.
---

# Modules
# CDKTF modules

A [Terraform module](/terraform/language/modules) is a single directory that contains one or more configuration files.

Expand Down
9 changes: 5 additions & 4 deletions website/docs/cdktf/concepts/providers.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
page_title: Providers - CDK for Terraform
page_title: CDKTF 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
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
with external APIs. Learn how to install and use Terraform providers in
TypeScript, Python, Java, C#, and Go.
---

# Providers
# CDKTF 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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/remote-backends.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Remote Backends - CDK for Terraform
page_title: Remote backends in CDKTF
description: >-
Configure a remote backend where Terraform can store infrastructure state
files remotely.
Configure remote backends in CDK for Terraform to store infrastructure state
robin-norwood marked this conversation as resolved.
Show resolved Hide resolved
files remotely, including files from HCP Terraform and other supported backends.
---

# Remote Backends
# Remote backends in CDKTF

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.

Expand Down
7 changes: 4 additions & 3 deletions website/docs/cdktf/concepts/resources.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
page_title: Resources - CDK for Terraform
page_title: CDKTF 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
# CDKTF 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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/stacks.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Stacks - CDK for Terraform
page_title: Infrastructure stacks with CDKTF
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 CDKTF

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.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/tokens.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Tokens - CDK for Terraform
page_title: Tokens in CDKTF
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 CDKTF

Tokens represent values that are unknown until Terraform applies your configuration. For example, names of cloud resources are only assigned upon creation.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/cdktf/concepts/variables-and-outputs.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
page_title: Variables and Outputs - CDK for Terraform
page_title: Variables and outputs in CDKTF
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
# 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:

Expand Down
Loading
Loading