-
Notifications
You must be signed in to change notification settings - Fork 76
[FWF Docs]: Fix typos, grammar, and snippets & fix broken links in all developer.fermyon.com #1529
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
0895f09
b8845d0
e894c8c
87725c8
09b9233
98120ef
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,7 +20,7 @@ To list all Spin applications deployed to your _Fermyon Wasm Functions_ account, | |
$ spin aka apps list | ||
``` | ||
|
||
Depending on which apps you have deployed to your _Fermyon Wasm Functions_ account, the actual output will differ from the output shown here. | ||
Depending on which apps you have deployed to your _Fermyon Wasm Functions_ account, the actual output will differ from the output shown here: | ||
|
||
<!-- @nocpy --> | ||
|
||
|
@@ -50,7 +50,7 @@ This time, you'll receive the list of Spin applications as `JSON` array: | |
] | ||
``` | ||
|
||
You can also use the `--verbose` flag to learn more about your apps. Below, you'll see the spin app names alongside their respective app ids. | ||
You can also use the `--verbose` flag to learn more about your apps. Below, you'll see the Spin app names alongside their respective app identifiers: | ||
|
||
```console | ||
$ spin aka apps list --verbose | ||
|
@@ -61,7 +61,7 @@ query-external-database(b6cc1427-392c-4f96-859d-bb4d0adc216c) | |
|
||
## Inspecting an Application | ||
|
||
Use the `spin aka apps info` command, to gather fundamental information about a Spin application deployed to your _Fermyon Wasm Functions_ account. The command requires the name of the desired application to be passed as an argument to the `--app` flag: | ||
Use the `spin aka apps info` command, to gather fundamental information about a Spin application deployed to your _Fermyon Wasm Functions_ account. The command requires the name of the desired application to be passed as an argument to the `--name` flag: | ||
|
||
<!-- @selectiveCpy --> | ||
|
||
|
@@ -72,8 +72,10 @@ $ spin aka apps info --name hello-fermyon-wasm-functions | |
<!-- @nocpy --> | ||
|
||
```console | ||
Name: hello-fermyon-wasm-functions | ||
Name: hello-fermyon-wasm-functions (25a5fd1e-d476-40fd-bc54-6cee0e846540) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No action for now, but I've raised an issue for ID to be a separate field like it is in the JSON |
||
URL: https://25a5fd1e-d476-40fd-bc54-6cee0e846540.aka.fermyon.tech/ | ||
Created at: 2025-04-15 17:22:55 UTC | ||
Invocations: 29 in the past 7 days | ||
``` | ||
|
||
As you can see, you'll also receive the public origin, which could be used to access the Spin application. Similar to the `spin aka apps list` command, you could add the `--format json` flag to make the command return fundamental information about a particular application as `JSON` object: | ||
|
@@ -87,8 +89,11 @@ $ spin aka apps info --name hello-fermyon-wasm-functions --format json | |
|
||
```json | ||
{ | ||
"id": "25a5fd1e-d476-40fd-bc54-6cee0e846540", | ||
"name": "hello-fermyon-wasm-functions", | ||
"url": "https://25a5fd1e-d476-40fd-bc54-6cee0e846540.aka.fermyon.tech/" | ||
"url": "https://25a5fd1e-d476-40fd-bc54-6cee0e846540.aka.fermyon.tech/", | ||
"created_at": "2025-04-15 17:22:55 UTC", | ||
"invocations": "29 in the past 7 days" | ||
} | ||
``` | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,7 +93,7 @@ $ spin plugin install aka | |
|
||
## Install Language Specific Tooling | ||
|
||
With Spin you can build applications using a wide variety of different programming languages. This quickstart, contains instructions and samples for JavaScript, TypeScript and Rust. | ||
With Spin you can build applications using a wide variety of different programming languages. This quickstart, contains instructions and samples for JavaScript, TypeScript, Rust and TinyGo. | ||
|
||
Language specific tooling must be installed on your machine, follow these installation instructions: | ||
|
||
|
@@ -428,6 +428,11 @@ Finished building all Spin components | |
|
||
```bash | ||
$ spin build | ||
``` | ||
|
||
<!-- @nocpy --> | ||
|
||
```console | ||
Executing the build command for component hello-spin: tinygo build -target=wasi -gc=leaking -no-debug -o main.wasm main.go | ||
go: downloading github.com/spinframework/spin/sdk/go v0.10.0 | ||
Finished building all Spin components | ||
|
@@ -437,8 +442,9 @@ If the build fails, check: | |
|
||
* Are you in the `hello-spin` directory? | ||
* Did you successfully [install TinyGo](#install-language-specific-tooling)? | ||
* Are your versions of Go and TinyGo up to date? The Spin SDK needs TinyGo 0.27 or above. | ||
* Are your versions of Go and TinyGo up to date? The Spin SDK needs TinyGo 0.27 or above. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @adamreese Is this version requirement still correct? Spin docs says TinyGo 0.35 and Go 1.22. https://spinframework.dev/v3/quickstart#build-your-application |
||
* Set Environment Variable `CGO_ENABLED=1`. (Since the Go SDK is built using CGO, it requires the CGO_ENABLED=1 environment variable to be set.) | ||
* Are your Spin templates up-to-date? Use `spin templates upgrade` to upgrade them | ||
|
||
If you would like to know what build command Spin runs for a component, you can find it in the manifest, in the `component.(id).build` section: | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ElephantSQL is discontinued, and we shouldn't refer to it. (I thought I had addressed this somewhere but I can't find a PR so... I guess I didn't.) I realise this turns the edit into a rather bigger research and conversion exercise, though, so feel free to raise a separate issue and punt on it.