Skip to content

chore: add comments to docs #3863

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 15, 2025
Merged

chore: add comments to docs #3863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b3045c
chore: add comments to docs
LeahMarieBush Apr 29, 2025
da2bc10
chore: Update test snapshot
mutahhir May 7, 2025
c207542
Merge branch 'main' into leah/chore/add-docs-comments
LeahMarieBush May 14, 2025
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
2 changes: 1 addition & 1 deletion test/csharp/provider-list-command/__snapshots__/test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ exports[`provider list command lists both local and prebuilt providers with tabu
Name Version Constraint Version
───────────┼─────────────────────────────┼────────────────────────┼────────────┤
─── ───── ─ ── ───────── ────
null │ 3.2.3 ~> 3.2.0│ │ │
null │ 3.2.4 ~> 3.2.0│ │ │

───────────┼─────────────────────────────┼────────────────────────┼────────────┤
─── ───── ─ ── ───────── ────
Expand Down
3 changes: 3 additions & 0 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Terraform Documentation

> [!IMPORTANT]
> **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.

This directory contains the portions of [the Terraform website][terraform.io] that pertain to the Terraform CDK.

The files in this directory are intended to be used in conjunction with
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: CSharp Reference for Classes
description: CDKTF Core API Reference for Classes in CSharp.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# CSharp: Classes <a name="Classes" id="Classes"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/constructs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: CSharp Reference for Constructs
description: CDKTF Core API Reference for Constructs in CSharp.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# CSharp: Constructs <a name="Constructs" id="Constructs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/enums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: CSharp Reference for Enums
description: CDKTF Core API Reference for Enums in CSharp.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# CSharp: Enums <a name="Enums" id="Enums"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: C# API resource reference overview
description: Learn about the API resources available in the Terraform CDK library for C#.
---

> [!IMPORTANT]
> **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.

# C# API resource reference overview

The C# API reference includes the following resources:
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/protocols.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: CSharp Reference for Protocols
description: CDKTF Core API Reference for Protocols in CSharp.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# CSharp: Protocols <a name="Protocols" id="Protocols"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/csharp/structs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: CSharp Reference for Structs
description: CDKTF Core API Reference for Structs in CSharp.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# CSharp: Structs <a name="Structs" id="Structs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go Reference for Classes
description: CDKTF Core API Reference for Classes in Go.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Go: Classes <a name="Classes" id="Classes"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/constructs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go Reference for Constructs
description: CDKTF Core API Reference for Constructs in Go.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Go: Constructs <a name="Constructs" id="Constructs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/enums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go Reference for Enums
description: CDKTF Core API Reference for Enums in Go.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Go: Enums <a name="Enums" id="Enums"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go API resource reference overview
description: Learn about the API resources available in the Terraform CDK library for golang.
---

> [!IMPORTANT]
> **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.

# Go API resource reference overview

The Go API reference includes the following resources:
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/protocols.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go Reference for Protocols
description: CDKTF Core API Reference for Protocols in Go.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Go: Protocols <a name="Protocols" id="Protocols"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/go/structs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Go Reference for Structs
description: CDKTF Core API Reference for Structs in Go.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Go: Structs <a name="Structs" id="Structs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ 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.
---

> [!IMPORTANT]
> **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.

# 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
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java Reference for Classes
description: CDKTF Core API Reference for Classes in Java.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Java: Classes <a name="Classes" id="Classes"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/constructs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java Reference for Constructs
description: CDKTF Core API Reference for Constructs in Java.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Java: Constructs <a name="Constructs" id="Constructs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/enums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java Reference for Enums
description: CDKTF Core API Reference for Enums in Java.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Java: Enums <a name="Enums" id="Enums"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java API resource reference overview
description: Learn about the API resources available in the Terraform CDK library for Java.
---

> [!IMPORTANT]
> **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.

# Java API resource reference overview

The Java API reference includes the following resources:
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/protocols.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java Reference for Protocols
description: CDKTF Core API Reference for Protocols in Java.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Java: Protocols <a name="Protocols" id="Protocols"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/java/structs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Java Reference for Structs
description: CDKTF Core API Reference for Structs in Java.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Java: Structs <a name="Structs" id="Structs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/provider.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: >-
The CDKTF provider bindings are used to make your CDKTF application run with different Terraform providers
---

> [!IMPORTANT]
> **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.

# Provider API Reference

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
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python Reference for Classes
description: CDKTF Core API Reference for Classes in Python.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Python: Classes <a name="Classes" id="Classes"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/constructs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python Reference for Constructs
description: CDKTF Core API Reference for Constructs in Python.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Python: Constructs <a name="Constructs" id="Constructs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/enums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python Reference for Enums
description: CDKTF Core API Reference for Enums in Python.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Python: Enums <a name="Enums" id="Enums"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python API resource reference overview
description: Learn about the API resources available in the Terraform CDK library for Python.
---

> [!IMPORTANT]
> **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.

# Python API resource reference overview

The Python API reference includes the following resources:
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/protocols.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python Reference for Protocols
description: CDKTF Core API Reference for Protocols in Python.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Python: Protocols <a name="Protocols" id="Protocols"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/python/structs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Python Reference for Structs
description: CDKTF Core API Reference for Structs in Python.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Python: Structs <a name="Structs" id="Structs"></a>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/cdktf/api-reference/typescript/classes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ page_title: Typescript Reference for Classes
description: CDKTF Core API Reference for Classes in Typescript.
---

> [!IMPORTANT]
> **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.

<!-- This file is generated through yarn generate-docs -->

# Typescript: Classes <a name="Classes" id="Classes"></a>
Expand Down
Loading
Loading