Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/api/hub/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following is a list of the types of content that a user can submit to the Sp
- Spin Application examples
- Code snippets
- **(Spin) Templates**
- Complete components such as the [Spin static-fileserver](https://github.com/fermyon/spin-fileserver)
- Complete components such as the [Spin static-fileserver](https://github.com/spinframework/spin-fileserver)
- **(Spin) Plugins**
- Triggers and tools
- See Lee-Orr’s Message trigger: [https://github.com/lee-orr/spin-message-trigger](https://github.com/lee-orr/spin-message-trigger)
Expand Down Expand Up @@ -237,7 +237,7 @@ $ git push -u origin my_new_branch

If you return to your GitHub repository in your browser, you will notice that a PR has automatically been generated for you.

Clicking on the green “Compare and pull request” button will allow you to add a title and description as part of the PR.
Clicking on the green “Compare and pull request” button will allow you to add a title and description as part of the PR.

![Compare and pull request](/static/image/compare_and_pull_request.png)

Expand Down
3 changes: 1 addition & 2 deletions content/api/hub/sample_hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ keywords = "Hugo, spin-fileserver, SSG, template, Fermyon Cloud"

### Getting started

The [hugo-spin](https://github.com/ThorstenHans/hugo-spin) comes with all batteries included to serve your next [Hugo](https://gohugo.io) site leveraging the [`spin-fileserver`](https://github.com/fermyon/spin-fileserver).
The [hugo-spin](https://github.com/ThorstenHans/hugo-spin) comes with all batteries included to serve your next [Hugo](https://gohugo.io) site leveraging the [`spin-fileserver`](https://github.com/spinframework/spin-fileserver).

To get started, open the [hugo-spin](https://github.com/ThorstenHans/hugo-spin) repository and click the "Use this template" button. Once you've created your own repository from the template, you can use the `make start` and `make deploy` to either build and the site locally, or to deploy it to Fermyon Cloud.

4 changes: 2 additions & 2 deletions content/api/hub/template_http_empty copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v0.7"
summary = "A template to create an HTTP application with no components"
url = "https://github.com/fermyon/spin/tree/main/templates/http-empty"
url = "https://github.com/spinframework/spin/tree/main/templates/http-empty"
template_id = "http-empty"
repo_url = "https://github.com/fermyon/spin"
repo_url = "https://github.com/spinframework/spin"
keywords = "web app, http, api, starter"

---
Expand Down
6 changes: 3 additions & 3 deletions content/api/hub/template_http_go copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v0.2"
summary = "A template to create an HTTP handler in Go"
url = "https://github.com/fermyon/spin/tree/main/templates/http-go"
url = "https://github.com/spinframework/spin/tree/main/templates/http-go"
template_id = "http-go"
repo_url = "https://github.com/fermyon/spin"
repo_url = "https://github.com/spinframework/spin"
keywords = "web app, http, api"

---

This is the default HTTP trigger template for Go. It installs by default with the [Spin install script](../../spin/install#installing-spin).

This guide walks you through how to use it: [HTTP Components](../../spin/go-components#http-components)
This guide walks you through how to use it: [HTTP Components](../../spin/go-components#http-components)
6 changes: 3 additions & 3 deletions content/api/hub/template_http_js copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v0.8"
summary = "A template to create an HTTP handler in JavaScript"
url = "https://github.com/fermyon/spin-js-sdk/tree/main/templates/http-js"
url = "https://github.com/spinframework/spin-js-sdk/tree/main/templates/http-js"
template_id = "http-js"
repo_url = "https://github.com/fermyon/spin-js-sdk"
repo_url = "https://github.com/spinframework/spin-js-sdk"
keywords = "web app, http, api"

---

This is the default HTTP trigger template for JavaScript. It installs by default with the [Spin install script](../../spin/install#installing-spin).

This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components#http-components)
This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components#http-components)
6 changes: 3 additions & 3 deletions content/api/hub/template_http_python copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v2.2"
summary = "A template to create an HTTP handler in Python"
url = "https://github.com/fermyon/spin-python-sdk/tree/main/templates/http-py"
url = "https://github.com/spinframework/spin-python-sdk/tree/main/templates/http-py"
template_id = "http-py"
repo_url = "https://github.com/fermyon/spin-python-sdk"
repo_url = "https://github.com/spinframework/spin-python-sdk"
keywords = "web app, http, api"

---
Expand All @@ -32,4 +32,4 @@ If you do not have Python 3.10 or later, you can install it by following the ins

This is the default HTTP trigger template for Python. It installs by default with the [Spin install script](../../spin/install#installing-spin).

This guide walks you through how to use it: [Structure of a Python Component](../../spin/python-components#structure-of-a-python-component)
This guide walks you through how to use it: [Structure of a Python Component](../../spin/python-components#structure-of-a-python-component)
6 changes: 3 additions & 3 deletions content/api/hub/template_http_rust copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v0.2"
summary = "A template to create an HTTP handler in Rust"
url = "https://github.com/fermyon/spin/tree/main/templates/http-rust"
url = "https://github.com/spinframework/spin/tree/main/templates/http-rust"
template_id = "http-rust"
repo_url = "https://github.com/fermyon/spin"
repo_url = "https://github.com/spinframework/spin"
keywords = "web app, http, api"

---

This is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](../../spin/install#installing-spin).

This guide walks you through how to use it: [HTTP Components](../../spin/rust-components#http-components)
This guide walks you through how to use it: [HTTP Components](../../spin/rust-components#http-components)
6 changes: 3 additions & 3 deletions content/api/hub/template_http_ts copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2022-10-15T00:22:56Z"
spin_version = ">v0.8"
summary = "A template to create an HTTP handler in TypeScript"
url = "https://github.com/fermyon/spin-js-sdk/tree/main/templates/http-ts"
url = "https://github.com/spinframework/spin-js-sdk/tree/main/templates/http-ts"
template_id = "http-ts"
repo_url = "https://github.com/fermyon/spin-js-sdk"
repo_url = "https://github.com/spinframework/spin-js-sdk"
keywords = "web app, http, api"

---

This is the default HTTP trigger template for TypeScript. It installs by default with the [Spin install script](../../spin/install#installing-spin).

This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components#http-components)
This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components#http-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_spin_fileserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ created_at = "2022-10-15T00:22:56Z"
last_updated = "2023-03-14T00:22:56Z"
spin_version = ">v0.1"
summary = "A Spin template to serve static assets."
url = "https://github.com/fermyon/spin-fileserver"
url = "https://github.com/spinframework/spin-fileserver"
template_id = "static-fileserver"
repo_url = "https://github.com/fermyon/spin"
repo_url = "https://github.com/spinframework/spin"
keywords = "static websites, fileserver"

---
Expand Down
8 changes: 4 additions & 4 deletions content/bartholomew/contributing-bartholomew.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ $ cd ~/bartholomew
$ make bart
```

Once built, you will find the very useful `bart` CLI executable in the `~/bartholomew/target/release` directory.
Once built, you will find the very useful `bart` CLI executable in the `~/bartholomew/target/release` directory.

For more information about how to use the CLI, please type `~/bartholomew/target/release/bart --help`, as shown below:

<!-- @selectiveCpy -->

```bash
$ ~/bartholomew/target/release/bart --help
$ ~/bartholomew/target/release/bart --help
bart 0.6.0
The Bartholomew CLI

Expand Down Expand Up @@ -269,7 +269,7 @@ The output from the above command will be similar to the following (depending on

## The Relationship Between Bartholomew and Spin

To run Bartholomew, you will need a Spin-capable runtime.
To run Bartholomew, you will need a Spin-capable runtime.

For Spin, follow [the Spin quickstart guide](https://spinframework.dev/quickstart) which details how to either:
- download the latest Spin binary release,
Expand Down Expand Up @@ -456,7 +456,7 @@ The final stage of a successful contribution will be a notification that the PR

## Thank You

At this point, you have performed a significant amount of work which is greatly appreciated.
At this point, you have performed a significant amount of work which is greatly appreciated.

Thank you for contributing!

Expand Down
2 changes: 1 addition & 1 deletion content/bartholomew/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Here are some additional details about [creating a repository from a template](h

## Fetch Your Site

Clone the repository which you created in the previous step:
Clone the repository which you created in the previous step:

<!-- @nocpy -->

Expand Down
16 changes: 8 additions & 8 deletions content/spin/v1/ai-sentiment-analysis-api-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ In this tutorial we will:

## Tutorial Prerequisites

### Spin
### Spin

You will need to [install the latest version of Spin](install#installing-spin). Serverless AI is supported on Spin versions 1.5 and above.
You will need to [install the latest version of Spin](install#installing-spin). Serverless AI is supported on Spin versions 1.5 and above.

If you already have Spin installed, [check what version you are on and upgrade](upgrade#are-you-on-the-latest-version) if required.

Expand Down Expand Up @@ -78,7 +78,7 @@ $ spin templates install --git https://github.com/spinframework/spin-python-sdk

> This tutorial uses [Meta AI](https://ai.meta.com/)'s Llama 2, Llama Chat and Code Llama models you will need to visit [Meta's Llama webpage](https://ai.meta.com/resources/models-and-libraries/llama-downloads/) and agree to Meta's License, Acceptable Use Policy, and to Meta’s privacy policy before fetching and using Llama models.

## Serverless AI Inferencing With Spin Applications
## Serverless AI Inferencing With Spin Applications

Now, let's dive deep into a comprehensive tutorial and unlock your potential to use Fermyon Serverless AI.
**Note:** The full source code with other examples can be found in our [Github repo](https://github.com/fermyon/ai-examples/tree/main)
Expand Down Expand Up @@ -640,9 +640,9 @@ We create an `assets` directory where we can store files to serve statically (se
$ mkdir assets
```

### Add the Front-End
### Add the Front-End

We can add a webpage that asks the user for some text and does the sentiment analysis on it. In your assets folder, create two files `dynamic.js` and `index.html`.
We can add a webpage that asks the user for some text and does the sentiment analysis on it. In your assets folder, create two files `dynamic.js` and `index.html`.

Here's the code snippet for `index.html`

Expand Down Expand Up @@ -716,7 +716,7 @@ Here's the code snippet for `index.html`
</html>
```

Here's the code snippet for `dynamic.js`
Here's the code snippet for `dynamic.js`

```javascript
// Listen for the Enter key being pressed
Expand Down Expand Up @@ -870,7 +870,7 @@ route = "/api/..."
command = "npm run build"

[[component]]
source = { url = "https://github.com/fermyon/spin-fileserver/releases/download/v0.0.3/spin_static_fs.wasm", digest = "sha256:38bf971900228222f7f6b2ccee5051f399adca58d71692cdfdea98997965fd0d" }
source = { url = "https://github.com/spinframework/spin-fileserver/releases/download/v0.0.3/spin_static_fs.wasm", digest = "sha256:38bf971900228222f7f6b2ccee5051f399adca58d71692cdfdea98997965fd0d" }
id = "ui"
files = [ { source = "assets", destination = "/" } ]
[component.trigger]
Expand Down Expand Up @@ -913,7 +913,7 @@ $ curl -vXPOST 'localhost:3000/api/sentiment-analysis' -H'Content-Type: applicat

### Deploy to Fermyon Cloud

Deploying to the Fermyon Cloud is one simple command. If you have not logged into your Fermyon Cloud account already, the CLI will prompt you to login. Follow the instructions to complete the authorization process.
Deploying to the Fermyon Cloud is one simple command. If you have not logged into your Fermyon Cloud account already, the CLI will prompt you to login. Follow the instructions to complete the authorization process.

<!-- @selectiveCpy -->

Expand Down
2 changes: 1 addition & 1 deletion content/spin/v1/contributing-spin.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ to make to Spin, make sure you can correctly build the project:

```bash
# clone the repository
$ git clone https://github.com/fermyon/spin && cd spin
$ git clone https://github.com/spinframework/spin && cd spin
# add a new remote pointing to your fork of the project
$ git remote add fork https://github.com/<your-username>/spin
# create a new branch for your work
Expand Down
10 changes: 5 additions & 5 deletions content/spin/v1/go-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import (
"fmt"
"net/http"

spinhttp "github.com/fermyon/spin/sdk/go/http"
spinhttp "github.com/spinframework/spin/sdk/go/http"
)

func init() {
Expand Down Expand Up @@ -95,7 +95,7 @@ import (
"net/http"
"os"

spinhttp "github.com/fermyon/spin/sdk/go/http"
spinhttp "github.com/spinframework/spin/sdk/go/http"
)

func init() {
Expand Down Expand Up @@ -191,7 +191,7 @@ package main
import (
"fmt"

"github.com/fermyon/spin/sdk/go/redis"
"github.com/spinframework/spin/sdk/go/redis"
)

func init() {
Expand Down Expand Up @@ -276,8 +276,8 @@ import (
"net/http"
"os"

spin_http "github.com/fermyon/spin/sdk/go/http"
"github.com/fermyon/spin/sdk/go/redis"
spin_http "github.com/spinframework/spin/sdk/go/http"
"github.com/spinframework/spin/sdk/go/redis"
)

func init() {
Expand Down
6 changes: 3 additions & 3 deletions content/spin/v1/http-outbound.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,11 @@ You can find a complete example for using outbound HTTP in the [Python SDK repos

{{ startTab "TinyGo"}}

HTTP functions are available in the `github.com/fermyon/spin/sdk/go/http` package. [See Go Packages for reference documentation.](https://pkg.go.dev/github.com/fermyon/spin/sdk/go/http). The general function is named `Send`, but the Go SDK also surfaces individual functions, with request-specific parameters, for the `Get` and `Post` operations. For example:
HTTP functions are available in the `github.com/spinframework/spin/sdk/go/http` package. [See Go Packages for reference documentation.](https://pkg.go.dev/github.com/spinframework/spin/sdk/go/http). The general function is named `Send`, but the Go SDK also surfaces individual functions, with request-specific parameters, for the `Get` and `Post` operations. For example:

```go
import (
spinhttp "github.com/fermyon/spin/sdk/go/http"
spinhttp "github.com/spinframework/spin/sdk/go/http"
)

res1, err1 := spinhttp.Get("https://random-data-api.fermyon.app/animals/json")
Expand Down Expand Up @@ -164,4 +164,4 @@ You must still grant permission by including `self` in `allowed_http_hosts`:

```toml
allowed_http_hosts = ["self"]
```
```
6 changes: 3 additions & 3 deletions content/spin/v1/http-trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For example, suppose the application `base` path is `base = "/shop"`. Then a co
### Resolving Overlapping Routes

If multiple components could potentially handle the same request based on their
defined routes, the component whose route has the longest matching prefix
defined routes, the component whose route has the longest matching prefix
takes precedence. This also means that exact matches take precedence over wildcard matches.

In the following example, requests starting with the `/users/` prefix (e.g. `/users/1`)
Expand Down Expand Up @@ -235,7 +235,7 @@ import (
"fmt"
"net/http"

spinhttp "github.com/fermyon/spin/sdk/go/http"
spinhttp "github.com/spinframework/spin/sdk/go/http"
)

func init() {
Expand Down Expand Up @@ -474,7 +474,7 @@ When exposing HTTP triggers using HTTPS you must provide `spin up` with a TLS ce

The `spin up` command's `--tls-cert` and `--tls-key` trigger options provide a way for you to specify both a TLS certificate and a private key (whilst running the `spin up` command).

The `--tls-cert` option specifies the path to the TLS certificate to use for HTTPS, if this is not set, normal HTTP will be used. The certificate should be in PEM format.
The `--tls-cert` option specifies the path to the TLS certificate to use for HTTPS, if this is not set, normal HTTP will be used. The certificate should be in PEM format.

The `--tls-key` option specifies the path to the private key to use for HTTPS, if this is not set, normal HTTP will be used. The key should be in PKCS#8 format. For more information, please see the [Spin CLI Reference](./cli-reference#trigger-options).

Expand Down
12 changes: 6 additions & 6 deletions content/spin/v1/key-value-store-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ $ spin new http-go spin-key-value

## Configuration

Good news - Spin will take care of setting up your key value store. However, in order to make sure your Spin application has permission to access the key value store, you must add the `key_value_stores = ["default"]` line in the `[[component]]` area of the `spin.toml` file. This line is necessary to communicate to Spin that a given component has access to the default key value store. A newly scaffolded Spin application will not have this line; you will need to add it.
Good news - Spin will take care of setting up your key value store. However, in order to make sure your Spin application has permission to access the key value store, you must add the `key_value_stores = ["default"]` line in the `[[component]]` area of the `spin.toml` file. This line is necessary to communicate to Spin that a given component has access to the default key value store. A newly scaffolded Spin application will not have this line; you will need to add it.

>> Tip: You can choose between various store implementations by modifying [the runtime configuration](dynamic-configuration.md#key-value-store-runtime-configuration). The default implementation uses [SQLite](https://www.sqlite.org/index.html) within the Spin framework.

Expand Down Expand Up @@ -175,7 +175,7 @@ command = "tinygo build -target=wasi -gc=leaking -no-debug -o main.wasm main.go"

## Write Code to Save and Load Data

In this section, we use the Spin SDK to open and persist our application's data inside our default key/value store. This is a special store that every environment running Spin applications will make available for their application.
In this section, we use the Spin SDK to open and persist our application's data inside our default key/value store. This is a special store that every environment running Spin applications will make available for their application.

> Please note: Spin applications written in Rust can [store and retrieve Rust data structures](./rust-components#storing-data-in-the-spin-key-value-store) in the application's data store.

Expand Down Expand Up @@ -338,8 +338,8 @@ import (
"io"
"net/http"

spin_http "github.com/fermyon/spin/sdk/go/http"
"github.com/fermyon/spin/sdk/go/key_value"
spin_http "github.com/spinframework/spin/sdk/go/http"
"github.com/spinframework/spin/sdk/go/key_value"
)

func init() {
Expand Down Expand Up @@ -412,7 +412,7 @@ func main() {}

## Building and Deploying Your Spin Application

Now let's build and deploy our Spin Application locally. Run the following command to build your application:
Now let's build and deploy our Spin Application locally. Run the following command to build your application:

<!-- @selectiveCpy -->

Expand Down Expand Up @@ -443,7 +443,7 @@ We can now use a `HEAD` request to confirm that our component is holding data fo
<!-- @selectiveCpy -->

```bash
$ curl -I HEAD localhost:3000/test -v
$ curl -I HEAD localhost:3000/test -v

Trying 127.0.0.1:3000...
* Connected to localhost (127.0.0.1) port 3000
Expand Down
Loading