Skip to content

Commit

Permalink
fix(docs): fix reference to docs.winglang.io links (#3208)
Browse files Browse the repository at this point in the history
fixes #3167
## Checklist

- [x] Title matches [Winglang's style guide](https://docs.winglang.io/contributing/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 [Monada Contribution License](https://docs.winglang.io/terms-and-policies/contribution-license.html)*.
  • Loading branch information
Eyal Keren authored Jul 3, 2023
1 parent 9f24a21 commit b7ac6c2
Show file tree
Hide file tree
Showing 34 changed files with 91 additions and 91 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Checklist

- [ ] Title matches [Winglang's style guide](https://docs.winglang.io/contributing/pull_requests#how-are-pull-request-titles-formatted)
- [ ] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted)
- [ ] 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 [Monada Contribution License](https://docs.winglang.io/terms-and-policies/contribution-license.html)*.
*By submitting this pull request, I confirm that my contribution is made under the terms of the [Monada Contribution License](https://www.winglang.io/terms-and-policies/contribution-license.html)*.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ the [Wing Slack].

Here is a curated list of topics from the [Wing Contributor's Handbook]:

* [How can I help?](https://docs.winglang.io/contributing/)
* [How do I submit a bug report?](https://docs.winglang.io/contributing/start-here/bugs)
* [How do I submit a pull request?](https://docs.winglang.io/contributing/start-here/pull_requests)
* [How to build Wing locally?](https://docs.winglang.io/contributing/start-here/development)
* [How do I add a resource to the SDK?](https://docs.winglang.io/contributing/start-here/wingsdk)
* [How can I help?](https://www.winglang.io/contributing/)
* [How do I submit a bug report?](https://www.winglang.io/contributing/start-here/bugs)
* [How do I submit a pull request?](https://www.winglang.io/contributing/start-here/pull_requests)
* [How to build Wing locally?](https://www.winglang.io/contributing/start-here/development)
* [How do I add a resource to the SDK?](https://www.winglang.io/contributing/start-here/wingsdk)

## Code of Conduct

The Wing community follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). Please review it before contributing issues, pull requests, or joining the [Wing Slack].

[Wing Slack]: https://t.winglang.io/slack
[Wing Contributor's Handbook]: https://docs.winglang.io/contributing/
[Wing Contributor's Handbook]: https://www.winglang.io/contributing/
[#contrib]: https://winglang.slack.com/archives/C04BJBTVDV4
[submitting an issue]: https://github.com/winglang/wing/issues/new
[submitting an issue]: https://github.com/winglang/wing/issues/new
54 changes: 26 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
<h1 align="center">Welcome to the Wing Language! :wave:</h1>
<p align="center">
<a href="https://docs.winglang.io/">Quick Start</a>
<a href="https://www.winglang.io/docs/">Quick Start</a>
▪︎
<a href="http://t.winglang.io/slack">Join Slack</a>
▪︎
<a href="https://docs.winglang.io">Docs</a>
<a href="https://www.winglang.io/docs/category/faq">FAQ</a>
▪︎
<a href="https://docs.winglang.io/category/faq">FAQ</a>
▪︎
<a href="https://docs.winglang.io/status#roadmap">Roadmap</a>
<a href="https://www.winglang.io/contributing/status#roadmap">Roadmap</a>
▪︎
<a href="https://github.com/winglang/wing/issues">Issues</a>
▪︎
<a href="https://github.com/winglang/wing/discussions">Discussions</a>
▪︎
<a href="https://docs.winglang.io/contributing/">Contribute</a>
<a href="https://www.winglang.io/contributing/">Contribute</a>
</p>

**Winglang** is a new open-source programming language designed for the cloud (aka "*cloud-oriented*").
Expand Down Expand Up @@ -71,50 +69,50 @@ called from inflight scopes.

### Very cool, but what here cannot be done by a library or compiler extension?
In existing languages, where there is no way to distinguish between multiple execution phases, it is impossible to naturally represent this idea that an object has methods that can only be executed from within a specific execution phase.
You are welcome to read more about it [here](https://docs.winglang.io/faq/why-a-language) (including code samples that show the same app built in Wing vs. other solutions).
You are welcome to read more about it [here](https://www.winglang.io/docs/faq/why-a-language) (including code samples that show the same app built in Wing vs. other solutions).

## What makes Wing a good fit for cloud development? 🌟

Wing was built from the ground up to make it an ideal choice for building applications on any cloud.
It includes an assembly of different features that serve that purpose:

* [Cloud services](https://docs.winglang.io/concepts/resources) as first-class citizens, with [phase modifiers](https://docs.winglang.io/contributing/rfcs/language-spec#13-phase-modifiers) for config or runtime (`preflight` and `inflight`).
* Higher level of cloud abstraction with a [standard library](https://docs.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec) of cloud resources that lets you write cloud portable code.
* [Compiler plugins](https://docs.winglang.io/reference/compiler-plugins) that keep you in control by allowing you to customize the compilation output, such as infrastructure definitions.
* [Cloud services](https://www.winglang.io/docs/faq/supported-clouds-services-and-engines/supported-services) as first-class citizens, with [phase modifiers](https://www.winglang.io/contributing/rfcs/language-spec#13-phase-modifiers) for config or runtime ([`preflight` and `inflight`](https://www.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec)).
* Higher level of cloud abstraction with a [standard library](https://www.winglang.io/contributing/rfcs/2023-01-20-wingsdk-spec) of cloud resources that lets you write cloud portable code.
* [Compiler plugins](https://www.winglang.io/docs/tools/compiler-plugins) that keep you in control by allowing you to customize the compilation output, such as infrastructure definitions.
* Use any resource in the Terraform ecosystem as first-class citizen in your app.
* [JavaScript interoperability](https://docs.winglang.io/contributing/rfcs/language-spec#5-interoperability).
* [Distributed computing primitives](https://docs.winglang.io/concepts/inflights).
* [JavaScript interoperability](https://www.winglang.io/contributing/rfcs/language-spec#5-interoperability).
* [Distributed computing primitives](https://www.winglang.io/docs/concepts/inflights).
* Automatic generation of IAM policies and other cloud mechanics based on intent.
* Local functional simulator with a visualization and interaction [console](https://docs.winglang.io/start-here/installation#wing-console) - used for testing and debugging with instant hot-reloading.
* [Native JSON](https://docs.winglang.io/contributing/rfcs/language-spec#114-json-type) and schema validation support.
* [Default immutability](https://docs.winglang.io/blog/2023/02/02/good-cognitive-friction#immutable-by-default).
* [Implicit async](https://docs.winglang.io/contributing/rfcs/language-spec#113-asynchronous-model), explicit defer.
* Local functional simulator with a visualization and interaction [console](https://www.winglang.io/docs/start-here/installation#wing-console) - used for testing and debugging with instant hot-reloading.
* [Native JSON](https://www.winglang.io/contributing/rfcs/language-spec#114-json-type) and schema validation support.
* [Default immutability](https://www.winglang.io/blog/2023/02/02/good-cognitive-friction#immutable-by-default).
* [Implicit async](https://www.winglang.io/contributing/rfcs/language-spec#113-asynchronous-model), explicit defer.

For a more in-depth look at Wing's features and benefits, check out our [documentation](https://docs.winglang.io/).
For a more in-depth look at Wing's features and benefits, check out our [documentation](https://www.winglang.io/docs/).

## Getting started 🛠️

> 🚧 Wing is still in alpha, and not recommended for production use. But we're excited for anyone to take part in shaping our
> roadmap and contributing in any way. Our [project status](https://docs.winglang.io/status) page includes more information about
> roadmap and contributing in any way. Our [project status](https://www.winglang.io/contributing/status) page includes more information about
> stability and roadmap.
You can install Wing in a few simple steps:

1. Check out the [Prerequisites](https://docs.winglang.io/start-here/installation#prerequisites).
2. Install the [Wing CLI](https://docs.winglang.io/start-here/installation#wing-cli).
3. Get the [Wing IDE Extension](https://docs.winglang.io/start-here/installation#wing-ide-extension) for your favorite editor.
4. Launch the [Wing Console](https://docs.winglang.io/start-here/installation#wing-console) and take it for a spin!
1. Check out the [Prerequisites](https://www.winglang.io/docs/start-here/installation#prerequisites).
2. Install the [Wing CLI](https://www.winglang.io/docs/start-here/installation#wing-cli).
3. Get the [Wing IDE Extension](https://www.winglang.io/docs/start-here/installation#wing-ide-extension) for your favorite editor.
4. Launch the [Wing Console](https://www.winglang.io/docs/start-here/installation#wing-console) and take it for a spin!

For a step-by-step guide, head over to our [Getting Started](https://docs.winglang.io/) guide.
For a step-by-step guide, head over to our [Getting Started](https://www.winglang.io/docs/) guide.
It's a once-in-a-lifetime adventure into the Wing rabbit hole!

## FAQs ❓

Here are some questions we're commonly asked that are covered by our [FAQ](https://docs.winglang.io/category/faq):
Here are some questions we're commonly asked that are covered by our [FAQ](https://www.winglang.io/docs/category/faq):

* [Who is behind this project?](https://docs.winglang.io/faq/who-is-behind-wing)
* [Which clouds are supported by Wing?](https://docs.winglang.io/faq/supported-clouds)
* [Which provisioning engines are supported by Wing?](https://docs.winglang.io/faq/supported-provisioning-engines)
* [Who is behind this project?](https://www.winglang.io/docs/faq/who-is-behind-wing)
* [Which clouds are supported by Wing?](https://www.winglang.io/docs/faq/supported-clouds-services-and-engines/supported-clouds)
* [Which provisioning engines are supported by Wing?](https://www.winglang.io/docs/faq/supported-clouds-services-and-engines/supported-provisioning-engines)

## Community 💬

Expand All @@ -139,7 +137,7 @@ We are incredibly grateful to our entire community for contributing bug fixes an
## License 📜

Wing is licensed under the [MIT License](./LICENSE.md).
Contributions are made under our [contribution license](https://docs.winglang.io/terms-and-policies/contribution-license.html).
Contributions are made under our [contribution license](https://www.winglang.io/terms-and-policies/contribution-license.html).

Happy coding, and remember: the sky's the limit with Wing (yes, another pun)! 🌤️🚀

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ function annotatePreflightError(error: Error): Error {
error.message,
"hint: Every preflight object needs a unique identifier within its scope. You can assign one as shown:",
'> new cloud.Bucket() as "MyBucket";',
"For more information, see https://docs.winglang.io/concepts/resources",
"For more information, see https://www.winglang.io/docs/concepts/resources",
);

// eslint-disable-next-line unicorn/error-message
Expand Down
2 changes: 1 addition & 1 deletion apps/wing/src/commands/compile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ function annotatePreflightError(error: Error): Error {
"hint: Every preflight object needs a unique identifier within its scope. You can assign one as shown:"
);
newMessage.push('> new cloud.Bucket() as "MyBucket";');
newMessage.push("For more information, see https://docs.winglang.io/concepts/resources");
newMessage.push("For more information, see https://www.winglang.io/docs/language-guide/language-reference#33-preflight-classes");

const newError = new Error(newMessage.join("\n\n"), { cause: error });
newError.stack = error.stack;
Expand Down
2 changes: 1 addition & 1 deletion apps/wing/src/commands/docs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ vi.mock("open");

test("wing docs opens the docs website", async () => {
await docs();
expect(open).toBeCalledWith("https://docs.winglang.io");
expect(open).toBeCalledWith("https://www.winglang.io/docs/");
});
2 changes: 1 addition & 1 deletion apps/wing/src/commands/docs.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import open from "open";

export async function docs() {
await open("https://docs.winglang.io");
await open("https://www.winglang.io/docs/");
}
4 changes: 2 additions & 2 deletions docs/contributing/02-maintainers/050-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing/03-stories/story-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/03-stories/story-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/999-rfcs/2022-05-28-winglang-reqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/999-rfcs/2023-04-16-website-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
<!--
This RFC has 3 sections: Requirements -> Design -> Implementation. We intentionally start with *Design* since it
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/999-rfcs/2023-06-12-language-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2304,7 +2304,7 @@ test "can add objects" {
The behavior of running tests with `wing test` CLI command is determined by the `cloud.TestRunner` resource in the Wing SDK, which can be implemented for any compiler target.
See the [CLI User Manual](https://docs.winglang.io/reference/cli#test-wing-test) for more details on running tests.
See the [CLI User Manual](https://www.winglang.io/docs/tools/cli#test-wing-test) for more details on running tests.
[`top`][top]
Expand Down Expand Up @@ -2461,7 +2461,7 @@ If [frozen](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Gl
### 6.1 Strings
String reference doc is available [here](https://docs.winglang.io/standard-library/sdk#string-).
String reference doc is available [here](https://www.winglang.io/docs/standard-library/std/api-reference#string-).
Type of string is UTF-16 internally.
All string declaration variants are multi-line.
Expand Down
Loading

0 comments on commit b7ac6c2

Please sign in to comment.