Skip to content

Commit

Permalink
fix(docs): broken links (#3091)
Browse files Browse the repository at this point in the history
new docs site structure caused some broken links
  • Loading branch information
ainvoner authored Jun 27, 2023
1 parent f3890b1 commit 06707db
Show file tree
Hide file tree
Showing 20 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/99-maintainers/050-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/contributing/999-rfcs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/docs/01-start-here/01-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/01-start-here/02-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/01-start-here/04-run-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/02-concepts/05-simulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/01-basic-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/02-basic-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/03-control-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/04-immutability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/05-null-safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/06-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/07-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/08-classes-and-interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/09-preflight-inflight.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/10-enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/11-structs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/12-javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
2 changes: 1 addition & 1 deletion docs/docs/03-language-guide/13-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))

0 comments on commit 06707db

Please sign in to comment.