Skip to content

Commit 76d707d

Browse files
LeahMarieBushkaitlynnefuery
LeahMarieBush
authored and
kaitlynnefuery
committed
chore: add comments to docs
1 parent 5ed6ecd commit 76d707d

Some content is hidden

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

80 files changed

+240
-0
lines changed

‎website/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Terraform Documentation
22

3+
> [!IMPORTANT]
4+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
5+
36
This directory contains the portions of [the Terraform website][terraform.io] that pertain to the Terraform CDK.
47

58
The files in this directory are intended to be used in conjunction with

‎website/docs/cdktf/api-reference/csharp/classes.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: CSharp Reference for Classes
33
description: CDKTF Core API Reference for Classes in CSharp.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# CSharp: Classes <a name="Classes" id="Classes"></a>

‎website/docs/cdktf/api-reference/csharp/constructs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: CSharp Reference for Constructs
33
description: CDKTF Core API Reference for Constructs in CSharp.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# CSharp: Constructs <a name="Constructs" id="Constructs"></a>

‎website/docs/cdktf/api-reference/csharp/enums.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: CSharp Reference for Enums
33
description: CDKTF Core API Reference for Enums in CSharp.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# CSharp: Enums <a name="Enums" id="Enums"></a>

‎website/docs/cdktf/api-reference/csharp/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: C# API resource reference overview
33
description: Learn about the API resources available in the Terraform CDK library for C#.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# C# API resource reference overview
710

811
The C# API reference includes the following resources:

‎website/docs/cdktf/api-reference/csharp/protocols.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: CSharp Reference for Protocols
33
description: CDKTF Core API Reference for Protocols in CSharp.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# CSharp: Protocols <a name="Protocols" id="Protocols"></a>

‎website/docs/cdktf/api-reference/csharp/structs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: CSharp Reference for Structs
33
description: CDKTF Core API Reference for Structs in CSharp.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# CSharp: Structs <a name="Structs" id="Structs"></a>

‎website/docs/cdktf/api-reference/go/classes.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go Reference for Classes
33
description: CDKTF Core API Reference for Classes in Go.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Go: Classes <a name="Classes" id="Classes"></a>

‎website/docs/cdktf/api-reference/go/constructs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go Reference for Constructs
33
description: CDKTF Core API Reference for Constructs in Go.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Go: Constructs <a name="Constructs" id="Constructs"></a>

‎website/docs/cdktf/api-reference/go/enums.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go Reference for Enums
33
description: CDKTF Core API Reference for Enums in Go.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Go: Enums <a name="Enums" id="Enums"></a>

‎website/docs/cdktf/api-reference/go/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go API resource reference overview
33
description: Learn about the API resources available in the Terraform CDK library for golang.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Go API resource reference overview
710

811
The Go API reference includes the following resources:

‎website/docs/cdktf/api-reference/go/protocols.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go Reference for Protocols
33
description: CDKTF Core API Reference for Protocols in Go.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Go: Protocols <a name="Protocols" id="Protocols"></a>

‎website/docs/cdktf/api-reference/go/structs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Go Reference for Structs
33
description: CDKTF Core API Reference for Structs in Go.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Go: Structs <a name="Structs" id="Structs"></a>

‎website/docs/cdktf/api-reference/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: >-
44
Use the CDKTF core library with generated provider bindings to write your CDKTF program. It is available in TypeScript, Python, Java, CSharp, and Go.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
9+
710
# Core Library API Reference
811

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

‎website/docs/cdktf/api-reference/java/classes.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java Reference for Classes
33
description: CDKTF Core API Reference for Classes in Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Java: Classes <a name="Classes" id="Classes"></a>

‎website/docs/cdktf/api-reference/java/constructs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java Reference for Constructs
33
description: CDKTF Core API Reference for Constructs in Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Java: Constructs <a name="Constructs" id="Constructs"></a>

‎website/docs/cdktf/api-reference/java/enums.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java Reference for Enums
33
description: CDKTF Core API Reference for Enums in Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Java: Enums <a name="Enums" id="Enums"></a>

‎website/docs/cdktf/api-reference/java/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java API resource reference overview
33
description: Learn about the API resources available in the Terraform CDK library for Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Java API resource reference overview
710

811
The Java API reference includes the following resources:

‎website/docs/cdktf/api-reference/java/protocols.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java Reference for Protocols
33
description: CDKTF Core API Reference for Protocols in Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Java: Protocols <a name="Protocols" id="Protocols"></a>

‎website/docs/cdktf/api-reference/java/structs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Java Reference for Structs
33
description: CDKTF Core API Reference for Structs in Java.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Java: Structs <a name="Structs" id="Structs"></a>

‎website/docs/cdktf/api-reference/provider.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ description: >-
44
The CDKTF provider bindings are used to make your CDKTF application run with different Terraform providers
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
9+
710
# Provider API Reference
811

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

‎website/docs/cdktf/api-reference/python/classes.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python Reference for Classes
33
description: CDKTF Core API Reference for Classes in Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Python: Classes <a name="Classes" id="Classes"></a>

‎website/docs/cdktf/api-reference/python/constructs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python Reference for Constructs
33
description: CDKTF Core API Reference for Constructs in Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Python: Constructs <a name="Constructs" id="Constructs"></a>

‎website/docs/cdktf/api-reference/python/enums.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python Reference for Enums
33
description: CDKTF Core API Reference for Enums in Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Python: Enums <a name="Enums" id="Enums"></a>

‎website/docs/cdktf/api-reference/python/index.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python API resource reference overview
33
description: Learn about the API resources available in the Terraform CDK library for Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
# Python API resource reference overview
710

811
The Python API reference includes the following resources:

‎website/docs/cdktf/api-reference/python/protocols.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python Reference for Protocols
33
description: CDKTF Core API Reference for Protocols in Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Python: Protocols <a name="Protocols" id="Protocols"></a>

‎website/docs/cdktf/api-reference/python/structs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Python Reference for Structs
33
description: CDKTF Core API Reference for Structs in Python.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Python: Structs <a name="Structs" id="Structs"></a>

‎website/docs/cdktf/api-reference/typescript/classes.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Typescript Reference for Classes
33
description: CDKTF Core API Reference for Classes in Typescript.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Typescript: Classes <a name="Classes" id="Classes"></a>

‎website/docs/cdktf/api-reference/typescript/constructs.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Typescript Reference for Constructs
33
description: CDKTF Core API Reference for Constructs in Typescript.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Typescript: Constructs <a name="Constructs" id="Constructs"></a>

‎website/docs/cdktf/api-reference/typescript/enums.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ page_title: Typescript Reference for Enums
33
description: CDKTF Core API Reference for Enums in Typescript.
44
---
55

6+
> [!IMPORTANT]
7+
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
8+
69
<!-- This file is generated through yarn generate-docs -->
710

811
# Typescript: Enums <a name="Enums" id="Enums"></a>

0 commit comments

Comments
 (0)