From 1c755acf5481591aed2ad682c6f17f2e3d020ed5 Mon Sep 17 00:00:00 2001 From: David Boyne Date: Mon, 8 Jul 2024 11:04:04 +0100 Subject: [PATCH] docs(docs): added list of platforms to help with discoverability (#6859) Mentioned by @eladb in https://github.com/winglang/wing/pull/6832 This is an idea to add a new page that lists all the supported platforms by Wing and quick links to dive deeper. List is split into two, ones that are natively supported by Wing (through CLI), and others that are "external" (requires installation). Think as we get more community platforms or custom platforms we can add the to this list. We can also link to this page in the CLI ? (following convo from https://github.com/winglang/wing/pull/6832) ## Checklist - [x ] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted) - [x ] Description explains motivation and solution - [ ] Tests added (always) - [ ] Docs updated (only required for features) - [ ] Added `pr/e2e-full` label if this feature requires end-to-end testing *By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*. --- .../055-platforms/{awscdk.md => 01-awscdk.md} | 0 docs/docs/055-platforms/{sim.md => 02-sim.md} | 0 .../055-platforms/{tf-aws.md => 03-tf-aws.md} | 0 .../{tf-azure.md => 04-tf-azure.md} | 0 .../055-platforms/{tf-gcp.md => 05-tf-gcp.md} | 0 docs/docs/055-platforms/06-all-platforms.md | 28 +++++++++++++++++++ 6 files changed, 28 insertions(+) rename docs/docs/055-platforms/{awscdk.md => 01-awscdk.md} (100%) rename docs/docs/055-platforms/{sim.md => 02-sim.md} (100%) rename docs/docs/055-platforms/{tf-aws.md => 03-tf-aws.md} (100%) rename docs/docs/055-platforms/{tf-azure.md => 04-tf-azure.md} (100%) rename docs/docs/055-platforms/{tf-gcp.md => 05-tf-gcp.md} (100%) create mode 100644 docs/docs/055-platforms/06-all-platforms.md diff --git a/docs/docs/055-platforms/awscdk.md b/docs/docs/055-platforms/01-awscdk.md similarity index 100% rename from docs/docs/055-platforms/awscdk.md rename to docs/docs/055-platforms/01-awscdk.md diff --git a/docs/docs/055-platforms/sim.md b/docs/docs/055-platforms/02-sim.md similarity index 100% rename from docs/docs/055-platforms/sim.md rename to docs/docs/055-platforms/02-sim.md diff --git a/docs/docs/055-platforms/tf-aws.md b/docs/docs/055-platforms/03-tf-aws.md similarity index 100% rename from docs/docs/055-platforms/tf-aws.md rename to docs/docs/055-platforms/03-tf-aws.md diff --git a/docs/docs/055-platforms/tf-azure.md b/docs/docs/055-platforms/04-tf-azure.md similarity index 100% rename from docs/docs/055-platforms/tf-azure.md rename to docs/docs/055-platforms/04-tf-azure.md diff --git a/docs/docs/055-platforms/tf-gcp.md b/docs/docs/055-platforms/05-tf-gcp.md similarity index 100% rename from docs/docs/055-platforms/tf-gcp.md rename to docs/docs/055-platforms/05-tf-gcp.md diff --git a/docs/docs/055-platforms/06-all-platforms.md b/docs/docs/055-platforms/06-all-platforms.md new file mode 100644 index 00000000000..642da433bcb --- /dev/null +++ b/docs/docs/055-platforms/06-all-platforms.md @@ -0,0 +1,28 @@ +--- +title: Wing Platforms +id: all-platforms +sidebar_label: List of platforms +description: List of platforms that for Wing +keywords: [Wing reference, Wing language, language, Wing language spec, Wing programming language, cli, terraform, tf-gcp, gcp, google cloud platform, platform] +--- + +List of platforms that are supported by Wing. + +## Native platforms + +Platforms that are native to Wing and part of the [Wing CLI](/docs/tools/cli). + +| Platform | Cloud provider | Description +| -------- | ------- | ------- +| [sim](/docs/platforms/sim) | Local simulation | A simple localhost implementation of all the resources of the [Wing Cloud Library](/docs/category/cloud) | +| [tf-aws](/docs/platforms/tf-aws) (Terraform) | AWS | Compiles your program for [Terraform](https://www.terraform.io/) and run on [AWS](https://aws.amazon.com/) | +| [tf-azure](/docs/platforms/tf-azure) (Terraform) | Microsoft Azure | Compiles your program for [Terraform](https://www.terraform.io/) and run on [Azure](https://azure.microsoft.com/) | +| [tf-gcp](/docs/platforms/tf-azure) (Terraform) | Google Cloud (GCP) | Compiles your program for [Terraform](https://www.terraform.io/) and run on [Google Cloud](https://cloud.google.com/) | + +## External platforms + +Platforms that are external to Wing and require installation. + +| Platform | Cloud provider | Description +| -------- | ------- | ------- +| [awscdk](/docs/platforms/awscdk) (CDK) | AWS | Compiles your program for the [AWS CDK](https://aws.amazon.com/cdk/) and deployed through the [CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/cli.html) (and AWS CloudFormation).| \ No newline at end of file