From e1f56b06d59da4bcc33225384c2b7217bdbcaeda Mon Sep 17 00:00:00 2001 From: monabot Date: Mon, 3 Jul 2023 19:46:15 +0000 Subject: [PATCH] feat(docs): update docs Updates the Wing docs. See details in [workflow run]. [Workflow Run]: https://github.com/winglang/docsite/actions/runs/5448037751 ------ *Automatically created via the "update-docs" workflow* Signed-off-by: monabot --- .../02-maintainers/050-operations.md | 4 +- .../version-latest/03-stories/story-04.md | 6 +- .../version-latest/03-stories/story-06.md | 2 +- .../999-rfcs/2022-05-28-winglang-reqs.md | 2 +- .../999-rfcs/2023-04-16-website-resource.md | 2 +- .../999-rfcs/2023-06-12-language-spec.md | 4 +- .../version-latest/999-rfcs/overview.md | 2 +- .../01-start-here/01-getting-started.md | 2 +- .../01-start-here/06-learn-more.md | 2 +- .../03-language-guide/90-reference.md | 4 +- .../04-standard-library/01-cloud/api.md | 92 ++++++++++++++++++- .../04-standard-library/01-cloud/function.md | 36 +++++++- .../04-standard-library/01-cloud/queue.md | 57 +++++++++++- .../03-http/api-reference.md | 16 ++++ .../999-faq/005-why-a-language.md | 2 +- .../version-latest/999-faq/010-good-fit.md | 20 ++-- .../999-faq/012-can-we-abstract-the-cloud.md | 2 +- .../021-supported-clouds.md | 6 +- .../022-supported-services.md | 4 +- .../023-supported-provisioning-engines.md | 4 +- .../025-kubernetes-support.md | 2 +- .../040-alternatives/041-terraform-vs-wing.md | 4 +- .../040-alternatives/042-pulumi-vs-wing.md | 4 +- .../040-alternatives/043-awscdk-vs-wing.md | 4 +- .../040-alternatives/044-cdktf-vs-wing.md | 2 +- .../version-latest/999-faq/093-secrets.md | 2 +- 26 files changed, 236 insertions(+), 51 deletions(-) diff --git a/contributing_versioned_docs/version-latest/02-maintainers/050-operations.md b/contributing_versioned_docs/version-latest/02-maintainers/050-operations.md index 4893c0e27..1796e8533 100644 --- a/contributing_versioned_docs/version-latest/02-maintainers/050-operations.md +++ b/contributing_versioned_docs/version-latest/02-maintainers/050-operations.md @@ -12,13 +12,13 @@ Both are important to the health of Wing however users should be prioritized ove User-facing projects and their supporting contributor pieces: - [Homepage](https://winglang.io) -- [Documentation](https://docs.winglang.io) +- [Documentation](https://www.winglang.io/docs/) - https://github.com/winglang/docsite - https://github.com/winglang/wing/tree/main/docs - Wing CLI - https://github.com/winglang/wing - Wing Console - - https://docs.winglang.io/core-concepts/simulator + - https://www.winglang.io/docs/concepts/simulator - [Playground](https://play.winglang.io) - [NPM Packages](https://www.npmjs.com/~monabot) (https://www.npmjs.com/package/winglang and https://www.npmjs.com/package/@winglang/sdk) - [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=Monada.vscode-wing) diff --git a/contributing_versioned_docs/version-latest/03-stories/story-04.md b/contributing_versioned_docs/version-latest/03-stories/story-04.md index 3e67ee57b..225931044 100644 --- a/contributing_versioned_docs/version-latest/03-stories/story-04.md +++ b/contributing_versioned_docs/version-latest/03-stories/story-04.md @@ -177,8 +177,8 @@ the log message `Hello, cloud!`. Now that you've written your first Wing program, what's next? Here are some resources to help you get started: -- [Wing Language Specification](https://docs.winglang.io/contributing/rfcs/language-spec) -- [Wing SDK Reference](https://docs.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec) +- [Wing Language Specification](https://www.winglang.io/contributing/rfcs/language-spec) +- [Wing SDK Reference](https://www.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec) ## Staying up to date @@ -222,7 +222,7 @@ As such, our focus for this sprint is: - Consolidate everything related to Wing into the [monadahq/winglang](https://github.com/monadahq/winglang/) GitHub repo. This includes: - The [Wing SDK](https://github.com/monadahq/wingsdk) - The [language spec](https://github.com/monadahq/winglang-spec) - should go under `docs/winglang-spec.md` - - The [language requirements RFC](https://docs.winglang.io/contributing/rfcs/2022-05-28-winglang-reqs) - + - The [language requirements RFC](https://www.winglang.io/contributing/rfcs/2022-05-28-winglang-reqs) - should go under `rfcs/winglang-reqs.md` - All issues should also be transfered into this repository. - Updating the main README file to match this RFC as close as possible. diff --git a/contributing_versioned_docs/version-latest/03-stories/story-06.md b/contributing_versioned_docs/version-latest/03-stories/story-06.md index 8a6a71375..f74421568 100644 --- a/contributing_versioned_docs/version-latest/03-stories/story-06.md +++ b/contributing_versioned_docs/version-latest/03-stories/story-06.md @@ -22,7 +22,7 @@ The winglang.io webpage is simple & clean (see [Figma](https://www.figma.com/fil It says below "Sign up for early access". She can't wait... Puts her email and clicks "submit". A message pops up saying that she should be expecting an email from us on how you can register, she goes into her inbox and sees she got an email from Elad that welcomes and asks her to fill in a short form so we can learn more about her before giving her access. She clicks the link. Her web browser takes her to a short form that asks her questions about her job (devops/developer/both/other), how she heard about wing, etc, and also her github username. She submits the form and gets a message, β€œthank you for submitting the form, please expect a github invitation to github.com/winglang/wing repo in your email”, she goes back to her email where an invite email is awaiting her. Wow these guys are quick! She clicks the link, approves the invite and goes to grab coffee. -She lands in https://githug.com/winglang/wing and starts skimming through the README.md. It is clear to her that this project is in a very early stage, both because of the amount of stars and because of the first commit time. The big disclaimer at the top of the README.md also provides a hint. She starts reading the README and is excited to see the quick screencasts of what it looks like to write and compile wing software. She is psyched to take wing for a spin. She follows the instructions in the README (Mona Lisa told her about that already from Sprint 4), downloads the toolchain, writes the little "Hello World" and it works, sweet! The README points to a https://docs.winglang.io, to learn more about the language and its capabilities. She clicks on the link, where she reads about why we need a language like wing, and what is currently supported, she learns about inflights, resources, and Polymorphism. She reads through the language reference, and the roadmap and browses through the Wing SDK documentation. She feels like this might be a beginning of something big! +She lands in https://githug.com/winglang/wing and starts skimming through the README.md. It is clear to her that this project is in a very early stage, both because of the amount of stars and because of the first commit time. The big disclaimer at the top of the README.md also provides a hint. She starts reading the README and is excited to see the quick screencasts of what it looks like to write and compile wing software. She is psyched to take wing for a spin. She follows the instructions in the README (Mona Lisa told her about that already from Sprint 4), downloads the toolchain, writes the little "Hello World" and it works, sweet! The README points to a https://www.winglang.io/docs/, to learn more about the language and its capabilities. She clicks on the link, where she reads about why we need a language like wing, and what is currently supported, she learns about inflights, resources, and Polymorphism. She reads through the language reference, and the roadmap and browses through the Wing SDK documentation. She feels like this might be a beginning of something big! Maria starts playing with the language, she wants to take this to the next level, and see how it is to build something with this, F$#!#! the disclaimer... She compiles a very simple program and gets a compiler error with the following message β€œ'for' loops are not yet supported, please +1 https://winglang/wing/issues/119". She goes to GitHub and clicks the πŸ‘ to indicate this is a feature she is after. A couple of minutes later she gets a notification from github with a reply from a guy named Mark. He comments on the issue: diff --git a/contributing_versioned_docs/version-latest/999-rfcs/2022-05-28-winglang-reqs.md b/contributing_versioned_docs/version-latest/999-rfcs/2022-05-28-winglang-reqs.md index 9afc26a5e..cfc6a7e83 100644 --- a/contributing_versioned_docs/version-latest/999-rfcs/2022-05-28-winglang-reqs.md +++ b/contributing_versioned_docs/version-latest/999-rfcs/2022-05-28-winglang-reqs.md @@ -6,7 +6,7 @@ description: The original requirements documents for the wing language experienc - **Author(s):**: @eladb - **Submission Date**: {2022-05-28} - **Stage**: Approved -- **Implementation**: [Language Specification](https://docs.winglang.io/contributing/rfcs/language-spec) +- **Implementation**: [Language Specification](https://www.winglang.io/contributing/rfcs/language-spec) ## About this Document diff --git a/contributing_versioned_docs/version-latest/999-rfcs/2023-04-16-website-resource.md b/contributing_versioned_docs/version-latest/999-rfcs/2023-04-16-website-resource.md index 6991f7d20..bffdc2daa 100644 --- a/contributing_versioned_docs/version-latest/999-rfcs/2023-04-16-website-resource.md +++ b/contributing_versioned_docs/version-latest/999-rfcs/2023-04-16-website-resource.md @@ -19,7 +19,7 @@ Stage: Fill in with current stage in the RFC lifecycle Stage Date: Fill in with date of last stage change --> -> Implementing the website resource following the [SDK spec](https://docs.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec#website). +> Implementing the website resource following the [SDK spec](https://www.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec#website).