From 06707dba1526300630f77dd8f91af959d14cedd4 Mon Sep 17 00:00:00 2001 From: Ainvoner <2538825+ainvoner@users.noreply.github.com> Date: Tue, 27 Jun 2023 10:42:31 +0300 Subject: [PATCH] fix(docs): broken links (#3091) new docs site structure caused some broken links --- docs/contributing/99-maintainers/050-operations.md | 2 +- docs/contributing/999-rfcs/overview.md | 2 +- docs/contributing/index.md | 2 +- docs/docs/01-start-here/01-getting-started.md | 2 +- docs/docs/01-start-here/02-installation.md | 2 +- docs/docs/01-start-here/04-run-locally.md | 8 ++++---- docs/docs/02-concepts/05-simulator.md | 2 +- docs/docs/03-language-guide/01-basic-syntax.md | 2 +- docs/docs/03-language-guide/02-basic-types.md | 2 +- docs/docs/03-language-guide/03-control-flow.md | 2 +- docs/docs/03-language-guide/04-immutability.md | 2 +- docs/docs/03-language-guide/05-null-safety.md | 2 +- docs/docs/03-language-guide/06-modules.md | 2 +- docs/docs/03-language-guide/07-functions.md | 2 +- docs/docs/03-language-guide/08-classes-and-interfaces.md | 2 +- docs/docs/03-language-guide/09-preflight-inflight.md | 2 +- docs/docs/03-language-guide/10-enums.md | 2 +- docs/docs/03-language-guide/11-structs.md | 2 +- docs/docs/03-language-guide/12-javascript.md | 2 +- docs/docs/03-language-guide/13-testing.md | 2 +- 20 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/contributing/99-maintainers/050-operations.md b/docs/contributing/99-maintainers/050-operations.md index f7072c100fc..4893c0e2747 100644 --- a/docs/contributing/99-maintainers/050-operations.md +++ b/docs/contributing/99-maintainers/050-operations.md @@ -129,6 +129,6 @@ Any maintainer should be empowered to take ownership of an incident if they wish The notification channel and timing is configured per user. It's recommended to configure it in the following way: -![](/99-maintainerstion-configuration.png) +![](./notification-configuration.png) for more information about notifications rules configuration, please refer to this [tutorial](https://support.pagerduty.com/docs/user-profile#notification-rules). diff --git a/docs/contributing/999-rfcs/overview.md b/docs/contributing/999-rfcs/overview.md index 68d5ec1bd47..59623e199ae 100644 --- a/docs/contributing/999-rfcs/overview.md +++ b/docs/contributing/999-rfcs/overview.md @@ -25,7 +25,7 @@ implementation. The next step is to write the first revision of the RFC document itself. -Create a file based off of the [`template.md`](/contributing/999-rfcs/template.md) under the `docs` directory. It includes useful guidance and tips on how to write a good RFC. +Create a file based off of the [`template.md`](/contributing/rfcs/template) under the `docs` directory. It includes useful guidance and tips on how to write a good RFC. **What should be included in an RFC?** The purpose of an RFC is to reduce ambiguity and risk and get approval for public-facing interfaces (APIs), which are "one-way doors" after the feature is released. Another way to think about it is that the goal and contents of the document should allow us to create a *high-confidence* implementation plan for a feature or a change. diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 960f727752b..e390c1ac4db 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -21,4 +21,4 @@ There are many ways to contribute to Wing: * Asking and answering questions in the [Wing Slack](https://t.winglang.io/slack) * Posting or answering questions in [Wing Discussions](https://github.com/winglang/wing/discussions) -![](docs/contributing/giphy.webp) +![](./giphy.webp) diff --git a/docs/docs/01-start-here/01-getting-started.md b/docs/docs/01-start-here/01-getting-started.md index 85ae1ea0648..09f5bf12eb2 100644 --- a/docs/docs/01-start-here/01-getting-started.md +++ b/docs/docs/01-start-here/01-getting-started.md @@ -83,7 +83,7 @@ environment variables and produce the code bundles needed for this to work. Here's a diagram that shows the architecture produced by this code: -![Architecture diagram produced by Wing](docs/docs/01-start-here/arch.png 'Architecture diagram') +![Architecture diagram produced by Wing](./arch.png 'Architecture diagram') In addition to targeting cloud providers, Wing applications can also be compiled to run inside a local **Cloud Simulator**. This means that you can now iterate diff --git a/docs/docs/01-start-here/02-installation.md b/docs/docs/01-start-here/02-installation.md index 65ba8fd85d2..bae25440d06 100644 --- a/docs/docs/01-start-here/02-installation.md +++ b/docs/docs/01-start-here/02-installation.md @@ -101,7 +101,7 @@ Wing applications running locally on the cloud simulator. 2. Accept the license agreement. 3. In macOS: drag the Wing Console app into **Applications** -![Drag the Wing Console app into Applications](docs/docs/01-start-here/console-install.png 'Wing Console app installation') +![Drag the Wing Console app into Applications](./console-install.png 'Wing Console app installation') [AWS account]: https://portal.aws.amazon.com/billing/signup diff --git a/docs/docs/01-start-here/04-run-locally.md b/docs/docs/01-start-here/04-run-locally.md index ce92bd9d834..f4fc02e2724 100644 --- a/docs/docs/01-start-here/04-run-locally.md +++ b/docs/docs/01-start-here/04-run-locally.md @@ -32,7 +32,7 @@ and load the application. Wing Console desktop application will show the following view of you application: -![Wing Console desktop application view](docs/docs/01-start-here/console-app.png 'Wing Console') +![Wing Console desktop application view](./console-app.png 'Wing Console') You are now able to run your IDE and the Wing Console side-by-side and watch how changes to your code update your application. @@ -47,7 +47,7 @@ resource. The inspector pane on the right will show information about your queue, as well as any relationships (in our case, an outbound relationship to the function that handles messages). -![Queue resource view in Wing Console](docs/docs/01-start-here/console-queue.png 'Queue resource') +![Queue resource view in Wing Console](./console-queue.png 'Queue resource') ## Sending a message to the queue @@ -58,11 +58,11 @@ Type `Wing` and hit **Send Message**. On the left sidebar click on the Bucket, you will see the following view: -![Bucket resource view in Wing Console](docs/docs/01-start-here/console-bucket-1.png 'Bucket resource') +![Bucket resource view in Wing Console](./console-bucket-1.png 'Bucket resource') Now, check the `wing.txt` file and download it, using the download button -![Download bucket files in Wing Console](docs/docs/01-start-here/console-bucket-2.png 'Download bucket files') +![Download bucket files in Wing Console](./console-bucket-2.png 'Download bucket files') The downloaded file should contain `Hello, Wing` text diff --git a/docs/docs/02-concepts/05-simulator.md b/docs/docs/02-concepts/05-simulator.md index 554001c4f6a..39a019246fe 100644 --- a/docs/docs/02-concepts/05-simulator.md +++ b/docs/docs/02-concepts/05-simulator.md @@ -14,7 +14,7 @@ application. There are two main ways to interact with the simulator: -* Running inflight [unit tests](docs/docs/02-concepts/04-tests.md) with the `wing test` command. +* Running inflight [unit tests](/02-concepts/04-tests.md) with the `wing test` command. * Interacting with the simulated application through the Wing Console The simulator is also available as a set of APIs exported through the diff --git a/docs/docs/03-language-guide/01-basic-syntax.md b/docs/docs/03-language-guide/01-basic-syntax.md index 8d1dc8fec92..9c63fece45f 100644 --- a/docs/docs/03-language-guide/01-basic-syntax.md +++ b/docs/docs/03-language-guide/01-basic-syntax.md @@ -3,4 +3,4 @@ title: Basic syntax id: basic-syntax --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/02-basic-types.md b/docs/docs/03-language-guide/02-basic-types.md index cbdb31e2a48..2bfdde12519 100644 --- a/docs/docs/03-language-guide/02-basic-types.md +++ b/docs/docs/03-language-guide/02-basic-types.md @@ -3,4 +3,4 @@ title: Basic types id: basic-types --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/03-control-flow.md b/docs/docs/03-language-guide/03-control-flow.md index 698d95a9724..5fcc77d39ac 100644 --- a/docs/docs/03-language-guide/03-control-flow.md +++ b/docs/docs/03-language-guide/03-control-flow.md @@ -3,4 +3,4 @@ title: Control flow id: control-flow --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/04-immutability.md b/docs/docs/03-language-guide/04-immutability.md index 91678263a93..bc7d0930c5c 100644 --- a/docs/docs/03-language-guide/04-immutability.md +++ b/docs/docs/03-language-guide/04-immutability.md @@ -3,4 +3,4 @@ title: Immutability id: immutability --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/05-null-safety.md b/docs/docs/03-language-guide/05-null-safety.md index dcf172d3035..c93f2ae1c59 100644 --- a/docs/docs/03-language-guide/05-null-safety.md +++ b/docs/docs/03-language-guide/05-null-safety.md @@ -3,4 +3,4 @@ title: Null safety id: null-safety --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/06-modules.md b/docs/docs/03-language-guide/06-modules.md index 99a5f2b2758..934af3140be 100644 --- a/docs/docs/03-language-guide/06-modules.md +++ b/docs/docs/03-language-guide/06-modules.md @@ -3,4 +3,4 @@ title: Modules id: modules --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/07-functions.md b/docs/docs/03-language-guide/07-functions.md index d4868c22531..ebbfc482684 100644 --- a/docs/docs/03-language-guide/07-functions.md +++ b/docs/docs/03-language-guide/07-functions.md @@ -3,4 +3,4 @@ title: Functions id: functions --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/08-classes-and-interfaces.md b/docs/docs/03-language-guide/08-classes-and-interfaces.md index fe2480bd15d..26f578eeac9 100644 --- a/docs/docs/03-language-guide/08-classes-and-interfaces.md +++ b/docs/docs/03-language-guide/08-classes-and-interfaces.md @@ -3,4 +3,4 @@ title: Classes and interfaces id: classes-and-interfaces --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/09-preflight-inflight.md b/docs/docs/03-language-guide/09-preflight-inflight.md index 8f59b51e1bd..8e6db79007f 100644 --- a/docs/docs/03-language-guide/09-preflight-inflight.md +++ b/docs/docs/03-language-guide/09-preflight-inflight.md @@ -3,4 +3,4 @@ title: Preflight and Inflight id: preflight-inflight --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/10-enums.md b/docs/docs/03-language-guide/10-enums.md index 6ae890da35f..e3c4b2dd4fe 100644 --- a/docs/docs/03-language-guide/10-enums.md +++ b/docs/docs/03-language-guide/10-enums.md @@ -3,4 +3,4 @@ title: Enums id: enums --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/11-structs.md b/docs/docs/03-language-guide/11-structs.md index 4750c32de6e..f873b24118f 100644 --- a/docs/docs/03-language-guide/11-structs.md +++ b/docs/docs/03-language-guide/11-structs.md @@ -3,4 +3,4 @@ title: Structs id: structs --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/12-javascript.md b/docs/docs/03-language-guide/12-javascript.md index 915d782572d..9004cb3ef90 100644 --- a/docs/docs/03-language-guide/12-javascript.md +++ b/docs/docs/03-language-guide/12-javascript.md @@ -3,4 +3,4 @@ title: JavaScript interoperability id: javascript-interop --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec)) diff --git a/docs/docs/03-language-guide/13-testing.md b/docs/docs/03-language-guide/13-testing.md index bca0914dbf7..8f4911df647 100644 --- a/docs/docs/03-language-guide/13-testing.md +++ b/docs/docs/03-language-guide/13-testing.md @@ -3,4 +3,4 @@ title: Testing id: testing --- -TODO (for now, see the [language spec RFC](docs/docs/999-contributorsibutors/999-rfcs/2023-06-12-language-spec.md)) +TODO (for now, see the [language spec RFC](rfcs/language-spec))