terraform-cdk icon indicating copy to clipboard operation
terraform-cdk copied to clipboard

Add multi-language code examples to docs

Open schersh opened this issue 2 years ago • 1 comments

Most of our docs only include TypeScript examples. We should add multi-language code blocks to examples in our documentation to highlight that there are five supported languages to use with CDKTF.

Scanning the codebase shows that there are currently 26 code blocks in our docs, so this work could be handled incrementally.

Reference: Guidance from the Education team on using CodeTabs to add multiple languages to code examples

schersh avatar Jul 15 '22 16:07 schersh

+1. Please provide examples in Python.

pchaganti avatar Jul 26 '22 20:07 pchaganti

The team spent a ton of time on this in the last quarter. There are a few tasks still remaining, such as #2607 and #2578, but since we've captured those in separate tickets, I'm going to go ahead and close out this "parent" issue.

xiehan avatar Feb 16 '23 12:02 xiehan

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

github-actions[bot] avatar Mar 19 '23 01:03 github-actions[bot]