winglang/wing

Docs: highlight multiple compilation targets support in Wing docs

Open

#844 opened on Dec 5, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue✨ enhancement📚 documentation

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Summary

Highlight multiple compilation targets support in Wing docs

Feature Spec

A FAQ we get is why does Wing compile to Terraform, not CloudFormation. Our documentation should highlight the fact that we currently have the Terraform target available, but plan to add CloudFormation target in the future.

Use Cases

Answer FAQ by people who come across Wing for the first time.

Implementation Notes

We should add an FAQ + consider other ways to communicate that through Wing docs.

Component

Documentation

Contributor guide

Research direction
Add an FAQ page explaining that currently Wing supports Terraform compilation, with plans for CloudFormation, and consider other UI elements to highlight multi target support.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85