jsteinich
commented
1 year ago Really nice to see this integration. A few initial thoughts:
- Would be nice to reference the pre-built provider imports rather than locally generated since using pre-built providers is recommended
- I'd prefer not having the full stack generated
- It adds verbosity that makes the examples appear more complicated
- It isn't actually the full code required since you need an app defined
- Subclassing stacks isn't necessarily the recommended approach. At the very least it can lead to testing complications: https://github.com/hashicorp/terraform-cdk/issues/1850
- Having the root provider page translated seems like a natural starting point. Ideally the use provider button would also switch
evanstachowiak
We are excited to announce CDK for Terraform multi-language provider docs in the Terraform Registry. This helps you simplify infrastructure provisioning and improve productivity by offering provider configuration options and code samples for the programming languages supported by CDKTF alongside the HCL documentation in the registry.
If you are new to working with a particular resource in your preferred programming language, such as TypeScript, for example, you can copy-paste the code samples from the multi-language provider docs in the registry and then adapt them for your needs. This is especially useful when starting a new project — no mental translation required.
We are launching this feature with the following set of providers and resources and plan to gradually expand the documentation over time:
To view the new documentation, navigate to the Terraform Registry and then to the particular resource page you want to provision in your CDKTF project. For example, if you’d want to provision an Amazon EC2 Dedicated Host in TypeScript, you can now find the translated snippet in the Registry by selecting “TypeScript” in the language selection dropdown.
If you notice a problem with any of the TypeScript or Python code snippets, please file a documentation bug report and we'll investigate. Otherwise, feel free to comment on this issue with your feedback on the feature as well as requests for resources or providers you'd like us to add documentation to next. Note that for the foreseeable future, we're prioritizing adding documentation to the official HashiCorp providers; Partner and Community providers are not (yet) on the roadmap.
Adding code samples in Java, C# and Go is on the roadmap, but we do not currently have an ETA on when we'll be rolling that out. We need to do more work to ensure that the generated code in those languages is accurate and good-quality; we do not want to provide code snippets that are incorrect and won't work when copy-pasted into your project. We'll keep the community updated once we have an estimated timeline for when this support will be added.
In the meantime, we hope that for many of you, this will vastly improve your developer experience when working with CDKTF, and we look forward to hearing your feedback!