winglang / winglang/wing

Make it clearer throughout our docs and websites that we support AWS CDK in addition to Terraform

Open
#3,905 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

✨ enhancement 📚 documentation
Dominant language
TypeScript
Stars
5.4k
Forks
215
Avg merge
2h 9m
Merged PRs (30d)
27

Description

Feature Spec

Anyone who skims through our docs doesn't get the impression that we are a Terraform shop only, especially when reading the getting started guild - https://www.winglang.io/docs/start-here/aws

Use Cases

We are losing potential users coming from the CDK that don't see we compile to the CDK.
It also creates concern that we have a risk related to the new TF licensing

Implementation Notes

We only give Terraform (or TF) as the compilation artifact throughout our docs. We should change this. Easiest thing would probably be to start by searching "Terraform" and "TF".
In the getting started guide, in the "Deploy to AWS" section, it also only shows how to deploy with TF (https://www.winglang.io/docs/start-here/aws).

We also give this impression on our websites.

Component

Documentation

Community Notes
  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by searching for “Terraform” and “TF” across the documentation and websites, then inspect the getting started guide at /docs/start-here/aws, especially the “Deploy to AWS” section. Done means the docs and website clearly communicate AWS CDK support alongside Terraform and explain the available deployment paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, terraform
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.