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 README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Prerequisites to run the website locally:

- [npm and node](https://docs.npmjs.com/cli/v8/configuring-npm/install)
- [Spin](https://developer.fermyon.com/spin/quickstart)
- [Spin](https://spinframework.dev/quickstart)

Build and run the website locally:

Expand All @@ -20,4 +20,4 @@ spin watch # Uses spin watch to run the website and reload when content changes.

2. View the website at `http://localhost:3000`.

If you would like to edit the contents of the [developer.fermyon.com](https://developer.fermyon.com/) website and contribute your changes, please visit the [Contributing to Docs](https://developer.fermyon.com/spin/contributing-docs) page.
If you would like to edit the contents of the [developer.fermyon.com](https://developer.fermyon.com/) website and contribute your changes, please visit the [Contributing to Docs](https://developer.fermyon.com/common/contributing-docs) page.
4 changes: 2 additions & 2 deletions content/api/hub/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ url = "https://github.com/spinframework/spin/tree/main/templates/http-rust"
Be sure to make a description of the hub item in the body (below the **`---`** line). The content that you write below the **`---`** line will be the content shown when the card is expanded in a modal view. For example:

```md
This is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](../../spin/install#installing-spin).
This is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/rust-components#http-components)
```

### Valid Metadata
Expand Down
4 changes: 2 additions & 2 deletions content/api/hub/plugin_js2wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ keywords = "plugins, packaging plugins, javascript, typescript"

---

This is an SDK for building Spin apps using JavaScript (and TypeScript). It installs by default with the [Spin install script](../../spin/install#installing-spin).
This is an SDK for building Spin apps using JavaScript (and TypeScript). It installs by default with the [Spin install script](https://spinframework.dev/install#installing-spin).

## Installation

```bash
spin plugins install js2wasm
```

This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components)
This guide walks you through how to use it: [HTTP Components](https://spinframework.dev/javascript-components)
2 changes: 1 addition & 1 deletion content/api/hub/sample_code_pls.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ Checkout the [app here](https://code-pls.fermyon.app/)

Get started with `spin build`, `spin up` and `spin deploy`.

[See the AI capabilities using Fermyon serverless AI!](https://developer.fermyon.com/spin/v2/serverless-ai-hello-world.md)
[See the AI capabilities using Fermyon serverless AI!](https://spinframework.dev/v2/serverless-ai-hello-world.md)


2 changes: 1 addition & 1 deletion content/api/hub/sample_http_auth_middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ cargo install --git https://github.com/bytecodealliance/cargo-component cargo-co
cargo install --git https://github.com/dicej/wasm-tools --branch wasm-compose-resource-imports wasm-tools --locked
```

* Install latest [Spin](../../spin/v2/install)
* Install latest [Spin](https://spinframework.dev/v2/install)
* Create an OAuth App in your [GitHub Developer Settings](https://github.com/settings/developers).
* Set the callback URL to `http://127.0.0.1:3000/login/callback`.
* Accept defaults and input dummy values for the rest of the fields.
Expand Down
2 changes: 1 addition & 1 deletion content/api/hub/sample_kv_in_python.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ keywords = "python, JSON, key-value"

---

Simple example of how to use Spin's built-in [key-value store](../../spin/v2/key-value-store-tutorial) to store and retrieve JSON documents in Python.
Simple example of how to use Spin's built-in [key-value store](https://spinframework.dev/v2/key-value-store-tutorial) to store and retrieve JSON documents in Python.
2 changes: 1 addition & 1 deletion content/api/hub/sample_kv_in_typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords = "typescript, javascript, key-value"

---

This sample shows how to use all of the different [Key/Value functions](../../spin/kv-store-api-guide) in TypeScript, including how to decode results, trap errors in a `try/catch`, and work with JSON.
This sample shows how to use all of the different [Key/Value functions](https://spinframework.dev/kv-store-api-guide) in TypeScript, including how to decode results, trap errors in a `try/catch`, and work with JSON.

This will help you get started with KV storage either locally using `spin up` or in Fermyon Cloud using `spin deploy`.

Expand Down
2 changes: 1 addition & 1 deletion content/api/hub/sample_ollama.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ keywords = "rust, ollama, llm, ai"
This sample demonstrates how spin can be used to implement the [Ollama api](https://github.com/jmorganca/ollama/blob/main/docs/api.md), which when deployed can be used as any other Ollama instance. LLM orchestration frameworks like LangChain and semantic kernel can use this instance as a Ollama backend.

## Quick Start
- [Install spin](../../spin/v2/install)
- [Install spin](https://spinframework.dev/v2/install)
- login to fermeyon cloud
```
spin login
Expand Down
6 changes: 3 additions & 3 deletions content/api/hub/sample_openaichat_ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ $ curl -d "Will I get a pet tortoise?" http://127.0.0.1:3000/question
The HTTP request is handled by the `handleRequest` function. Following is an overview of the process flow:

- Retreive the question by decoding the response body
- Fetch the OpenAPI Key from the Spin Config [Reference](../../spin/dynamic-configuration#custom-config-providers)
- Fetch the OpenAPI Key from the Spin Config [Reference](https://spinframework.dev/dynamic-configuration#custom-config-providers)
- Structure the request to be sent to OpenAI
- Decode the response
- Structure and return the response to the client.
Expand All @@ -76,8 +76,8 @@ Please refer to the code for the details of the implementation.

## References

- [Sending Outbound HTTP Requests](../../spin/javascript-components#sending-outbound-http-requests)
- [Sending Outbound HTTP Requests](https://spinframework.dev/javascript-components#sending-outbound-http-requests)

- [Spin Config](../../spin/dynamic-configuration#custom-config-providers)
- [Spin Config](https://spinframework.dev/dynamic-configuration#custom-config-providers)

- [Create chat completion](https://platform.openai.com/docs/api-reference/chat/create)
4 changes: 2 additions & 2 deletions content/api/hub/sample_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ keywords = "router, python"

---

This project showcases how to do internal HTTP routing in a Spin Python application. It is similar to [the Spin JS router](../../spin/v2/javascript-components#routing-in-a-component) as well as the Django router.
This project showcases how to do internal HTTP routing in a Spin Python application. It is similar to [the Spin JS router](https://spinframework.dev/v2/javascript-components#routing-in-a-component) as well as the Django router.

If you are interested in external routing (where the routing table is declared in the spin.toml), the [Application Structure guide](../../spin/v2/spin-application-structure) covers this.
If you are interested in external routing (where the routing table is declared in the spin.toml), the [Application Structure guide](https://spinframework.dev/v2/spin-application-structure) covers this.

This uses the absolutely fantastic [http_router](https://pypi.org/project/http-router/) project. You will likely want to reference the API docs:
* https://github.com/klen/http-router.
Expand Down
2 changes: 1 addition & 1 deletion content/api/hub/sample_ts_router_post.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ keywords = "typescript, javascript, router"

---

This shows one technique for handling POST data using the `Router` object [built into the JS/TS SDK](../../spin/v2/javascript-components) for Spin.
This shows one technique for handling POST data using the `Router` object [built into the JS/TS SDK](https://spinframework.dev/v2/javascript-components) for Spin.

This example illustrates how to pass the HTTP body from Spin's SDK all the way to your end function without needing to use middleware.

Expand Down
4 changes: 2 additions & 2 deletions content/api/hub/template_http_empty.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ keywords = "web app, http, api, starter"

---

This template creates an HTTP application with no components. It installs by default with the [Spin install script](../../spin/install#installing-spin).
This template creates an HTTP application with no components. It installs by default with the [Spin install script](https://spinframework.dev/install#installing-spin).

Use this template when you expect to [add](../../spin/writing-apps#adding-a-new-component-to-an-application) multiple components to an application, to help you establish an even directory structure.
Use this template when you expect to [add](https://spinframework.dev/writing-apps#adding-a-new-component-to-an-application) multiple components to an application, to help you establish an even directory structure.
4 changes: 2 additions & 2 deletions content/api/hub/template_http_go.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ 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 is the default HTTP trigger template for Go. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/go-components#http-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_http_js.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ 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 is the default HTTP trigger template for JavaScript. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/javascript-components#http-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_http_python.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ python3 --version

If you do not have Python 3.10 or later, you can install it by following the instructions [here](https://www.python.org/downloads/).

This is the default HTTP trigger template for Python. It installs by default with the [Spin install script](../../spin/install#installing-spin).
This is the default HTTP trigger template for Python. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/python-components#structure-of-a-python-component)
4 changes: 2 additions & 2 deletions content/api/hub/template_http_rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ 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 is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/rust-components#http-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_http_ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ 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 is the default HTTP trigger template for TypeScript. It installs by default with the [Spin install script](https://spinframework.dev/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](https://spinframework.dev/javascript-components#http-components)
2 changes: 1 addition & 1 deletion content/api/hub/template_kv_explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ keywords = "key-value, kv, explorer"

This template enables managing the key value pairs set in any key value store linked to an application.

To keep the contents of your key value store secure, the explorer expects the credentials to access the UI and the API to be stored in the configuration store as variables. Values can be set locally using the [variables provider](../../spin/v2/dynamic-configuration#application-variables-runtime-configuration) or you can skip checking for the credentials on every request by passing the `SPIN_APP_KV_SKIP_AUTH` environment variable. When deploying to cloud, set the `kv_explorer_user` and `kv_explorer_password` variables using the `--variable` flag. These credentials can then be updated at any time using `spin cloud variables set`.
To keep the contents of your key value store secure, the explorer expects the credentials to access the UI and the API to be stored in the configuration store as variables. Values can be set locally using the [variables provider](https://spinframework.dev/v2/dynamic-configuration#application-variables-runtime-configuration) or you can skip checking for the credentials on every request by passing the `SPIN_APP_KV_SKIP_AUTH` environment variable. When deploying to cloud, set the `kv_explorer_user` and `kv_explorer_password` variables using the `--variable` flag. These credentials can then be updated at any time using `spin cloud variables set`.

Visit the [GitHub repo](https://github.com/fermyon/spin-kv-explorer) for complete configuration instructions.

Expand Down
2 changes: 1 addition & 1 deletion content/api/hub/template_nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ keywords = "react, next.js, js, javascript, typescript"

This is a template for building and statically exporting your Next.js 13 application and running it on 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](https://spinframework.dev/javascript-components#http-components)
2 changes: 1 addition & 1 deletion content/api/hub/template_qwik_frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ This is a template for building and statically exporting your Qwik Frontend appl

Demo: [https://qwik.fermyon.app/](https://qwik.fermyon.app/)

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](https://spinframework.dev/javascript-components#http-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_redis_go.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ keywords = "web app, redis"

---

This is the default Redis pub-sub trigger template for Go. It installs by default with the [Spin install script](../../spin/install#installing-spin).
This is the default Redis pub-sub trigger template for Go. It installs by default with the [Spin install script](https://spinframework.dev/install#installing-spin).

This guide walks you through how to use it: [Redis Components](../../spin/go-components#redis-components)
This guide walks you through how to use it: [Redis Components](https://spinframework.dev/go-components#redis-components)
4 changes: 2 additions & 2 deletions content/api/hub/template_redis_rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ keywords = "web app, redis"

---

This is the default Redis pub-sub trigger template for Rust. It installs by default with the [Spin install script](../../spin/install#installing-spin).
This is the default Redis pub-sub trigger template for Rust. It installs by default with the [Spin install script](https://spinframework.dev/install#installing-spin).

This guide walks you through how to use it: [Redis Components](../../spin/rust-components#redis-components)
This guide walks you through how to use it: [Redis Components](https://spinframework.dev/rust-components#redis-components)
4 changes: 2 additions & 2 deletions content/bartholomew/contributing-bartholomew.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,14 +271,14 @@ The output from the above command will be similar to the following (depending on

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

For Spin, follow [the Spin quickstart guide](/spin/quickstart) which details how to either:
For Spin, follow [the Spin quickstart guide](https://spinframework.dev/quickstart) which details how to either:
- download the latest Spin binary release,
- clone and install Spin using cargo, or
- clone and build Spin from source.

## The Relationship Between Bartholomew and the Spin Fileserver

Bartholomew uses an external file server called [Spin-Fileserver](https://github.com/fermyon/spin-fileserver). This file server facilitates the presentation of files to the end users. For example, whilst the web page contents (HTML) are generated dynamically upon request, image elements in that HTML page source can point to images that are stored on the host server. The Spin file server ensures that these static images are correctly served to the client's web browser (as per the HTML's requirements.)
Bartholomew uses an external file server called [Spin-Fileserver](https://github.com/spinframework/spin-fileserver). This file server facilitates the presentation of files to the end users. For example, whilst the web page contents (HTML) are generated dynamically upon request, image elements in that HTML page source can point to images that are stored on the host server. The Spin file server ensures that these static images are correctly served to the client's web browser (as per the HTML's requirements.)

Please build the spin-fileserver and then copy the resulting `spin_static_fs.wasm` file into Bartholomew's `modules/` directory. This will ensure that you are running the latest release of the spin-fileserver.

Expand Down
2 changes: 1 addition & 1 deletion content/bartholomew/contributing-docs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
title = "Contributing to Docs"
template = "bartholomew_main"
date = "2022-01-01T00:00:01Z"
body_source = "/spin/v1/contributing-docs"
body_source = "/common/contributing-docs"
[extra]
url = "https://github.com/fermyon/developer/blob/main/content/bartholomew/contributing-docs.md"
keywords = "contribute contributing"
Expand Down
6 changes: 3 additions & 3 deletions content/bartholomew/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ url = "https://github.com/fermyon/developer/blob/main/content/bartholomew/index.
- [Taking Bartholomew for a Spin](#taking-bartholomew-for-a-spin)

Bartholomew is a simple CMS-like (Content Management System) tool for managing a
website. It is compiled to WebAssembly, and can run in any [Spin](/spin)
website. It is compiled to WebAssembly, and can run in any [Spin](https://spinframework.dev)
environment.

At a glance, with Bartholomew you can:
Expand All @@ -20,7 +20,7 @@ simple [TOML](https://toml.io/en/) header.
- Create custom page templates using the popular [Handlebars](https://handlebarsjs.com/)
templates.
- Build custom functions using [the Rhai scripting language](https://rhai.rs/).
- Serve files using [the Spin static file server](https://github.com/fermyon/spin-fileserver).
- Serve files using [the Spin static file server](https://github.com/spinframework/spin-fileserver).

## Overview

Expand All @@ -29,7 +29,7 @@ one you might find in AWS Lambda or Azure Functions. The CMS is only running whe
it needs to handle incoming requests, reducing the load on the servers
running it.

Bartholomew is a [Spin](/spin) component, and
Bartholomew is a [Spin](https://spinframework.dev) component, and
websites built with Bartholomew are Spin applications that can run in any
environment that is capable of running Spin. At Fermyon, we run all of our
websites using Bartholomew and Spin, on our [Fermyon Platform, running on Nomad](https://www.fermyon.com/blog/spin-nomad).
Expand Down
2 changes: 1 addition & 1 deletion content/bartholomew/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ key = "your custom name value pairs go hear, but values MUST be strings"
### Markdown Body

Markdown support includes all the usual stuff plus fenced codeblocks. Image links are
supported, but you need to use the external [fileserver](https://github.com/fermyon/spin-fileserver)
supported, but you need to use the external [fileserver](https://github.com/spinframework/spin-fileserver)
library to display the images. If you are using your deployment of Spin and Bartholomew, you can [read more about how to install the fileserver](/bartholomew/contributing-bartholomew) from source.

The last line of the example above is very important. The `---` tells Bartholomew that the head is done, and the body is coming up.
Expand Down
Loading