Skip to content

Commit 5d1256b

Browse files
committed
fix(content): fix broken links
Signed-off-by: Vaughn Dice <[email protected]>
1 parent a1cfd63 commit 5d1256b

28 files changed

+52
-78
lines changed

.build/check-broken-links.sh

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -69,47 +69,21 @@ report="$(mktemp)"
6969
blc_error=false
7070
blc --recursive http://127.0.0.1:3000 \
7171
\
72-
`## Ignore searching Edit links` \
73-
--exclude 'https://github.com/fermyon/developer/blob/main/content/*' \
74-
\
7572
`## returns 403` \
7673
--exclude 'https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits' \
7774
--exclude 'https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account' \
7875
--exclude 'https://docs.github.com/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email' \
7976
--exclude 'https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification' \
80-
--exclude 'https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template' \
81-
--exclude 'https://twitter.com/fermyontech' \
82-
--exclude 'https://twitter.com/fermyontech/status/1641537393818738710' \
83-
--exclude 'https://www.godaddy.com' \
77+
--exclude 'https://twitter.com/spinframework' \
8478
--exclude 'https://linux.die.net/man/1/which' \
8579
\
8680
`## false positives` \
8781
--exclude 'https://www.gnu.org/software/coreutils/' \
88-
--exclude 'https://events.hashicorp.com/hashitalksdeploy' \
89-
--exclude 'https://dotnet.microsoft.com/en-us/download/dotnet/8.0' \
90-
--exclude 'https://www.developerweek.com/' \
91-
--exclude 'https://marketplace.visualstudio.com/items?itemName=fermyon.spin-vscode&ssr=false#overview' \
92-
--exclude 'https://marketplace.visualstudio.com/items?itemName=fermyon.autobindle' \
9382
--exclude 'https://crates.io/' \
9483
--exclude 'https://crates.io/crates/bytes' \
9584
--exclude 'https://crates.io/crates/http' \
9685
--exclude 'https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one' \
97-
--exclude 'https://events.hashicorp.com/hashitalksdeploy' \
98-
--exclude 'https://www.instagram.com/fermyontech/' \
99-
--exclude 'https://www.linkedin.com/company/fermyon/' \
100-
--exclude 'https://support.google.com/webmasters/answer/7552505' \
101-
--exclude 'https://www.namecheap.com/support/knowledgebase/article.aspx/767/10/how-to-change-dns-for-a-domain/' \
102-
--exclude 'https://support.google.com/domains/answer/3290309?hl=en#' \
103-
--exclude 'https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor' \
104-
--exclude 'https://www.reddit.com/r/Clojure/comments/jkznto/web_assembly_clojure_current_state/' \
105-
--exclude 'https://www.reddit.com/r/Rlanguage/comments/b4izog/compile_r_to_webassembly_and_use_as_a_data/' \
106-
--exclude 'https://www.tutorialspoint.com/webassembly/webassembly_working_with_cplusplus.htm' \
107-
--exclude 'http://localhost:16686/' \
108-
--exclude 'http://localhost:5050/explore' \
109-
--exclude 'http://localhost:5050/explore' \
110-
--exclude 'https://stackshare.io/stackups/powershell-vs-webassembly' \
111-
--exclude 'https://blog.cloudflare.com/cloudflare-workers-now-support-cobol/' \
112-
--exclude 'https://support.google.com/webmasters/answer/9008080?hl=en' | tee "${report}" || blc_error=true
86+
--exclude 'http://localhost:5050/explore' | tee "${report}" || blc_error=true
11387

11488
cat "${report}" | grep "├─BROKEN─" > broken_links || true
11589

content/v1/dynamic-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ mount = "secret"
7575

7676
#### Vault Application Variable Provider Example
7777

78-
1. [Install Vault](https://developer.hashicorp.com/vault/tutorials/getting-started/getting-started-install).
78+
1. [Install Vault](https://developer.hashicorp.com/vault/tutorials/get-started/install-binary).
7979
2. Start Vault:
8080

8181
<!-- @selectiveCpy -->

content/v2/dynamic-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ mount = "secret"
7777

7878
#### Vault Application Variable Provider Example
7979

80-
1. [Install Vault](https://developer.hashicorp.com/vault/tutorials/getting-started/getting-started-install).
80+
1. [Install Vault](https://developer.hashicorp.com/vault/tutorials/get-started/install-binary).
8181
2. Start Vault:
8282

8383
<!-- @selectiveCpy -->

content/v2/http-outbound.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ You can find a complete example of using outbound HTTP in the JavaScript SDK rep
110110

111111
{{ startTab "Python"}}
112112

113-
> [**Want to go straight to the reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk/http/index.html)
113+
> [**Want to go straight to the reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk/http/index.html)
114114
115-
HTTP functions and classes are available in the `http` module. The function name is [`send`](https://fermyon.github.io/spin-python-sdk/http/index.html#spin_sdk.http.send). The [request type](https://fermyon.github.io/spin-python-sdk/http/index.html#spin_sdk.http.Request) is `Request`, and the [response type](https://fermyon.github.io/spin-python-sdk/http/index.html#spin_sdk.http.Response) is `Response`. For example:
115+
HTTP functions and classes are available in the `http` module. The function name is [`send`](https://spinframework.github.io/spin-python-sdk/http/index.html#spin_sdk.http.send). The [request type](https://spinframework.github.io/spin-python-sdk/http/index.html#spin_sdk.http.Request) is `Request`, and the [response type](https://spinframework.github.io/spin-python-sdk/http/index.html#spin_sdk.http.Response) is `Response`. For example:
116116

117117
```python
118118
from spin_sdk.http import Request, Response, send

content/v2/http-trigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,9 +284,9 @@ export async function handler(req: Request, res: ResponseBuilder) {
284284

285285
{{ startTab "Python"}}
286286

287-
> [**Want to go straight to the reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk/)
287+
> [**Want to go straight to the reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk/)
288288
289-
In Python, the application must define a top-level class named IncomingHandler which inherits from [IncomingHandler](https://fermyon.github.io/spin-python-sdk/http/index.html#spin_sdk.http.IncomingHandler), overriding the `handle_request` method.
289+
In Python, the application must define a top-level class named IncomingHandler which inherits from [IncomingHandler](https://spinframework.github.io/spin-python-sdk/http/index.html#spin_sdk.http.IncomingHandler), overriding the `handle_request` method.
290290

291291
```python
292292
from spin_sdk import http

content/v2/kv-store-api-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export async function handler(req: Request, res: ResponseBuilder) {
116116

117117
{{ startTab "Python"}}
118118

119-
> [**Want to go straight to the reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk/key_value.html)
119+
> [**Want to go straight to the reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk/key_value.html)
120120
121121
The key value functions are provided through the `spin_key_value` module in the Python SDK. For example:
122122

@@ -141,7 +141,7 @@ class IncomingHandler(http.IncomingHandler):
141141
**General Notes**
142142
- The Python SDK doesn't surface the `close` operation. It automatically closes all stores at the end of the request; there's no way to close them early.
143143

144-
[`get` **Operation**](https://fermyon.github.io/spin-python-sdk/wit/imports/key_value.html#spin_sdk.wit.imports.key_value.Store.get)
144+
[`get` **Operation**](https://spinframework.github.io/spin-python-sdk/wit/imports/key_value.html#spin_sdk.wit.imports.key_value.Store.get)
145145
- If a key does not exist, it returns `None`
146146

147147
{{ blockEnd }}

content/v2/language-support-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This page contains information about language support for Spin features:
6161

6262
{{ startTab "Python"}}
6363

64-
**[📄 Visit the Python Spin SDK reference documentation](https://fermyon.github.io/spin-python-sdk/v1) to see specific modules, functions, variables and syntax relating to the following Python SDK.**
64+
**[📄 Visit the Python Spin SDK reference documentation](https://spinframework.github.io/spin-python-sdk/v1) to see specific modules, functions, variables and syntax relating to the following Python SDK.**
6565

6666
| Feature | SDK Supported? |
6767
|-----|-----|

content/v2/python-components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ With <a href="https://www.python.org/" target="_blank">Python</a> being a very p
3333
3434
> This guide assumes you are familiar with the Python programming language, but if you are just getting started, be sure to check out <a href="https://docs.python.org/3/" target="_blank">the official Python documentation</a> and comprehensive <a href="https://docs.python.org/3/reference/" target="_blank">language reference</a>.
3535
36-
[**Want to go straight to the Spin SDK reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk)
36+
[**Want to go straight to the Spin SDK reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk)
3737

3838
## Prerequisite
3939

@@ -195,7 +195,7 @@ command = "componentize-py -w spin-http componentize app -o app.wasm"
195195

196196
In Spin, HTTP components are triggered by the occurrence of an HTTP request and must return an HTTP response at the end of their execution. Components can be built in any language that compiles to WASI. If you would like additional information about building HTTP applications you may find [the HTTP trigger page](./http-trigger.md) useful.
197197

198-
Building a Spin HTTP component using the Python SDK means defining a top-level class named IncomingHandler which inherits from [`IncomingHandler`](https://fermyon.github.io/spin-python-sdk/wit/exports/index.html#spin_sdk.wit.exports.IncomingHandler), overriding the `handle_request` method. Here is an example of the default Python code which the previous `spin new` created for us; a simple example of a request/response:
198+
Building a Spin HTTP component using the Python SDK means defining a top-level class named IncomingHandler which inherits from [`IncomingHandler`](https://spinframework.github.io/spin-python-sdk/wit/exports/index.html#spin_sdk.wit.exports.IncomingHandler), overriding the `handle_request` method. Here is an example of the default Python code which the previous `spin new` created for us; a simple example of a request/response:
199199

200200
<!-- @nocpy -->
201201

content/v2/rdbms-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export async function handler(_req: Request, res: ResponseBuilder) {
104104

105105
{{ startTab "Python"}}
106106

107-
> [**Want to go straight to the reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk/)
107+
> [**Want to go straight to the reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk/)
108108
109109
The code below is an [Outbound MySQL example](https://github.com/spinframework/spin-python-sdk/tree/main/examples/spin-mysql). There is also an outbound [PostgreSQL example](https://github.com/spinframework/spin-python-sdk/tree/main/examples/spin-postgres) available.
110110

content/v2/redis-outbound.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ You can find a complete TypeScript example for using outbound Redis from an HTTP
115115

116116
{{ startTab "Python"}}
117117

118-
> [**Want to go straight to the reference documentation?** Find it here.](https://fermyon.github.io/spin-python-sdk/redis.html)
118+
> [**Want to go straight to the reference documentation?** Find it here.](https://spinframework.github.io/spin-python-sdk/redis.html)
119119
120-
Redis functions are available in [the `redis` module](https://fermyon.github.io/spin-python-sdk/redis.html). The function names are prefixed `redis_`. You must pass the Redis instance address to _each_ operation as its first parameter. For example:
120+
Redis functions are available in [the `redis` module](https://spinframework.github.io/spin-python-sdk/redis.html). The function names are prefixed `redis_`. You must pass the Redis instance address to _each_ operation as its first parameter. For example:
121121

122122
```python
123123
from spin_sdk import redis

0 commit comments

Comments
 (0)