Skip to content

Commit 2885e6b

Browse files
authored
Merge pull request #27 from spinframework/docs/spin-naming-updates
docs(*): Less Fermyon, more Spin
2 parents 2c53e79 + 29e29a5 commit 2885e6b

29 files changed

+126
-234
lines changed

content/api/hub/contributing.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ date = "2023-07-20T12:00:00Z"
44
enable_shortcodes = true
55
[extra]
66
type = "contributing"
7-
url = "https://github.com/fermyon/developer/blob/main/content/api/hub/contributing.md"
7+
url = "https://github.com/spinframework/spin-docs/blob/main/content/api/hub/contributing.md"
88

99
---
1010

@@ -25,34 +25,30 @@ url = "https://github.com/fermyon/developer/blob/main/content/api/hub/contributi
2525
We are delighted that you are interested in making Spin Hub better! Thank you! This
2626
document will guide you through making your first contribution to the project.
2727

28-
First, any contribution and interaction on any Fermyon project MUST follow our
29-
[code of conduct](https://www.fermyon.com/code-of-conduct). Thank you for being
28+
First, any contribution and interaction on any spinframework project MUST follow our
29+
[code of conduct](https://github.com/spinframework/governance). Thank you for being
3030
part of an inclusive and open community!
3131

3232
## Contribution Procedure
3333

3434
### Fork the Repository
3535

36-
The first step is to fork the [developer repository](https://github.com/fermyon/developer), from Fermyon's GitHub, to your own GitHub account.
36+
The first step is to fork the [spin-docs repository](https://github.com/spinframework/spin-docs), from spinframework's GitHub, to your own GitHub account.
3737

38-
![Fork the repository](/static/image/fork_developer_repo.png)
39-
40-
Ensure that you are forking the developer repository **to your own** GitHub account; where you have full editing privileges.
38+
Ensure that you are forking the spin-docs repository **to your own** GitHub account; where you have full editing privileges.
4139

4240
### Clone the Fork
4341

4442
Copy the URL from the UI in readiness for running the `git clone` command.
4543

46-
![Fork the repository](/static/image/clone_developer_repo.png)
47-
4844
Go ahead and clone the new fork that you just created (the one which resides in your own GitHub account):
4945

5046
<!-- @nocpy -->
5147

5248
```bash
5349
$ cd ~
54-
$ git clone [email protected]:yourusername/developer.git
55-
$ cd developer
50+
$ git clone [email protected]:yourusername/spin-docs.git
51+
$ cd spin-docs
5652
```
5753

5854
### Create New Branch
@@ -72,7 +68,7 @@ Create a new remote for the upstream (a pointer to the original repository to wh
7268
<!-- @nocpy -->
7369

7470
```bash
75-
$ git remote add upstream https://github.com/fermyon/developer
71+
$ git remote add upstream https://github.com/spinframework/spin-docs
7672
```
7773

7874
### Creating Markdown
@@ -108,9 +104,9 @@ url = "https://github.com/spinframework/spin/tree/main/templates/http-rust"
108104
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:
109105

110106
```md
111-
This is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](../../spin/install#installing-spin).
107+
This is the default HTTP trigger template for Rust. It installs by default with the [Spin install script](../../install#installing-spin).
112108

113-
This guide walks you through how to use it: [HTTP Components](../../spin/rust-components#http-components)
109+
This guide walks you through how to use it: [HTTP Components](../../rust-components#http-components)
114110
```
115111

116112
### Valid Metadata
@@ -140,7 +136,7 @@ The following is a list of the types of content that a user can submit to the Sp
140136
- Spin Application examples
141137
- Code snippets
142138
- **(Spin) Templates**
143-
- Complete components such as the [Spin static-fileserver](https://github.com/fermyon/spin-fileserver)
139+
- Complete components such as the [Spin static-fileserver](https://github.com/spinframework/spin-fileserver)
144140
- **(Spin) Plugins**
145141
- Triggers and tools
146142
- See Lee-Orr’s Message trigger: [https://github.com/lee-orr/spin-message-trigger](https://github.com/lee-orr/spin-message-trigger)
@@ -165,9 +161,9 @@ $ npm run spin
165161

166162
### Add Changes
167163

168-
Once your changes have been checked, go ahead and add your changes by moving to a top-level directory, under which your changes exist i.e. `cd ~/developer`.
164+
Once your changes have been checked, go ahead and add your changes by moving to a top-level directory, under which your changes exist i.e. `cd ~/spin-docs`.
169165

170-
Add your changes by running the following command, from the root of the developer repository:
166+
Add your changes by running the following command, from the root of the spin-docs repository:
171167

172168
<!-- @nocpy -->
173169

@@ -219,10 +215,10 @@ The above command will return output similar to the following:
219215
<!-- @nocpy -->
220216

221217
```bash
222-
origin [email protected]:yourusername/developer.git (fetch)
223-
origin [email protected]:yourusername/developer.git (push)
224-
upstream https://github.com/fermyon/developer (fetch)
225-
upstream https://github.com/fermyon/developer (push)
218+
origin [email protected]:yourusername/spin-docs.git (fetch)
219+
origin [email protected]:yourusername/spin-docs.git (push)
220+
upstream https://github.com/spinframework/spin-docs (fetch)
221+
upstream https://github.com/spinframework/spin-docs (push)
226222
```
227223

228224
Once you are satisfied go ahead and push your changes:

content/api/hub/library_spin_contrib_http.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ language = "Rust"
1212
created_at = "2022-10-15T00:22:56Z"
1313
last_updated = "2022-10-15T00:22:56Z"
1414
spin_version = ">v1.4"
15-
summary = "This crate contains a bunch of helpers to build HTTP-based applications with Fermyon Spin."
15+
summary = "This crate contains a bunch of helpers to build HTTP-based applications with Spin."
1616
url = "https://github.com/ThorstenHans/spin-contrib-http"
1717
keywords = "http helpers, rust"
1818

1919
---
2020

2121
### Spin Contrib HTTP
2222

23-
This is a library created by Thorsten Hans which contains helpers to build HTTP-based applications with Fermyon Spin.
23+
This is a library created by Thorsten Hans which contains helpers to build HTTP-based applications with Spin.
2424

content/api/hub/plugin_spin_message_trigger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ language = "Rust"
1212
created_at = "2022-10-15T00:22:56Z"
1313
last_updated = "2022-10-15T00:22:56Z"
1414
spin_version = ">v1.4"
15-
summary = "A generic messaging trigger for Fermyon Spin"
15+
summary = "A generic messaging trigger for Spin"
1616
url = "https://github.com/lee-orr/spin-message-trigger"
1717
keywrods = "trigger, message, NATS"
1818

1919
---
2020

2121

22-
A generiuc messaging trigger for [Fermyon Spin](https://github.com/spinframework/spin). Note this is an experimental/work-in-progress repo, and is not production ready at this point. Also - if you have suggestions for improvements, feel free to make them in the Issues tab.
22+
A generic messaging trigger for [Spin](https://github.com/spinframework/spin). Note this is an experimental/work-in-progress repo, and is not production ready at this point. Also - if you have suggestions for improvements, feel free to make them in the Issues tab.
2323

2424
## Features
2525

content/api/hub/sample_11ty.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ keywords = "html, 11ty, javascript, Nunjucks"
1818

1919
---
2020

21-
This is a template for building and statically exporting your 11ty application and running it on Fermyon Spin.
21+
This is a template for building and statically exporting your 11ty application and running it on Spin.
2222

2323
All you need to do is open the [spin-11ty](https://github.com/VamshiReddy02/spin-11ty) repository and click the "Use this template" button. Once you've created your repository from the template, Run `npm install` and `npx start`, then start editing your application. Alternatively, you can run `spin build` and `spin up` to build and run your application.

content/api/hub/sample_bookmarker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ language = "Python"
1212
created_at = "2023-12-08T00:22:56Z"
1313
last_updated = "2023-12-08T00:22:56Z"
1414
spin_version = ">v2.0"
15-
summary = "This app uses Fermyon Spin's Python SDK to create and store bookmarks. It uses an LLM to generate a summary of the page."
15+
summary = "This app uses Spin's Python SDK to create and store bookmarks. It uses an LLM to generate a summary of the page."
1616
url = "https://github.com/technosophos/bookmarker"
1717

1818
---

content/api/hub/sample_bts_golang.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ keywords = "slack, go, nuxt.js, webhook"
1818

1919
---
2020

21-
A fun social photo app built using Fermyon Spin, Golang, Key-Value Store, and Nuxt.js.
21+
A fun social photo app built using Spin, Golang, Key-Value Store, and Nuxt.js.

content/api/hub/sample_hugo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ language = "Rust"
1212
created_at = "2023-08-31T10:52:54Z"
1313
last_updated = "2023-08-31T00:52:54Z"
1414
spin_version = ">v1.3"
15-
summary = "A template for deploying your Hugo site using Fermyon Spin and Cloud."
15+
summary = "A template for deploying your Hugo site using Spin and Cloud."
1616
url = "https://github.com/ThorstenHans/hugo-spin"
1717
keywords = "Hugo, spin-fileserver, SSG, template, Fermyon Cloud"
1818

content/api/hub/sample_jinja2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ keywords = "python, jinja2"
1818

1919
---
2020

21-
This is an example of using the [Jinja2 template engine](https://jinja.palletsprojects.com/en/3.1.x/) inside of a Fermyon Spin app. You will learn how to load templates off of the filesystem and then render them and serve them back to the client.
21+
This is an example of using the [Jinja2 template engine](https://jinja.palletsprojects.com/en/3.1.x/) inside of a Spin app. You will learn how to load templates off of the filesystem and then render them and serve them back to the client.
2222

2323
Jinja docs:
2424
* Python docs: https://jinja.palletsprojects.com/en/3.1.x/

content/api/hub/sample_tera.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ keywords = "rust, tera, cookies"
1818

1919
---
2020

21-
This is an example of using the [Tera template engine](https://keats.github.io/tera/) inside of a Fermyon Spin app. You will learn how to load templates off of the filesystem and then render them.
21+
This is an example of using the [Tera template engine](https://keats.github.io/tera/) inside of a Spin app. You will learn how to load templates off of the filesystem and then render them.
2222

2323
Also, you will learn how to use session cookies to have protected route and how to use `form-post` to submit data to spin route.
2424

content/api/hub/template_angular.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ keywords = "html, Angular, typescript"
2121

2222
# A Simple Static Fileserver Template for Spin Framework with Angular
2323

24-
This is a template for building and statically exporting your Angular application and running it on Fermyon Spin.
24+
This is a template for building and statically exporting your Angular application and running it on Spin.
2525

2626
## Using the Template
2727

content/api/hub/template_docusaurus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ keywords = "react, docusaurus, javascript, typescript"
2020

2121
---
2222

23-
This is a template for building and statically exporting your Docusaurus application and running it on Fermyon Spin.
23+
This is a template for building and statically exporting your Docusaurus application and running it on Spin.
2424

2525
All you need to do is open the [spin-docusaurus](https://github.com/VamshiReddy02/spin-docusaurus) repository and install the template in your spin CLI. Once you've created your repository from the template, Run `npm install` and `npx start`, then start editing your application. Alternatively, you can run `spin build` and `spin up` to build and run your application.

content/api/hub/template_jekyll.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ keywords = "html, Jekyll, ruby"
2020

2121
---
2222

23-
This is a template for building and statically exporting your Jekyll application and running it on Fermyon Spin.
23+
This is a template for building and statically exporting your Jekyll application and running it on Spin.
2424

2525
All you need to do is open the [spin-jekyll](https://github.com/VamshiReddy02/spin-jekyll) repository and click the "Use this template" button. Before you can build your Jekyll application, make sure to install ` jekyll and bundler gems`. You are now ready to start building your front-end. Run `bundle exec jekyll serve` and start editing your application. Alternatively, you can run `spin build` and `spin up` to build and run your application.

content/api/hub/template_nextjs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ keywords = "react, next.js, js, javascript, typescript"
2020

2121
---
2222

23-
This is a template for building and statically exporting your Next.js 13 application and running it on Fermyon Spin.
23+
This is a template for building and statically exporting your Next.js 13 application and running it on Spin.
2424

2525
This guide walks you through how to use it: [HTTP Components](../../spin/javascript-components#http-components)

content/api/hub/template_qwik_frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ keywords = "qwik, html, js, javascript, typescript"
2020

2121
---
2222

23-
This is a template for building and statically exporting your Qwik Frontend application and running it on Fermyon Spin.
23+
This is a template for building and statically exporting your Qwik Frontend application and running it on Spin.
2424

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

content/v1/ai-sentiment-analysis-api-tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ HTTP path: /api/...
144144

145145
### Supported AI Models
146146

147-
Fermyon's Spin and Serverless AI currently support:
147+
Spin and Serverless AI currently support:
148148
- Meta's open source Large Language Models (LLMs) [Llama](https://ai.meta.com/llama/), specifically the `llama2-chat` and `codellama-instruct` models (see Meta [Licenses](#licenses) section above).
149149
- SentenceTransformers' [embeddings](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) models, specifically the `all-minilm-l6-v2` model.
150150

@@ -887,7 +887,7 @@ route = "/internal/kv-explorer/..."
887887

888888
### Building and Deploying Your Spin Application
889889

890-
**Note:** Running inferencing on localhost (your CPU) is not as optimal as deploying to Fermyon's Serverless AI (where inferencing is performed by high-powered GPUs). You can skip this `spin build --up` step and move straight to `spin cloud deploy` if you:
890+
**Note:** Running inferencing on localhost (your CPU) is not as optimal as deploying to a dedicated Serverless AI platform (where inferencing is performed by high-powered GPUs). You can skip this `spin build --up` step and move straight to deployment if you:
891891

892892
- a) are using one of the 3 supported models above,
893893
- b) have configured your `spin.toml` file to explicitly configure the model (as shown above)
@@ -948,7 +948,7 @@ The groundbreaking Fermyon Serverless AI introduces a revolutionary addition to
948948

949949
## Conclusion
950950

951-
We want to get feedback on the Serverless AI API. We are curious about what models you would like to use and what applications you are building using Serverless AI. Let us know what you need, and how Fermyon's Serverless AI could potentially help solve a problem for you. We would love to help you write your new Serverless AI application.
951+
We want to get feedback on the Serverless AI API. We are curious about what models you would like to use and what applications you are building using Serverless AI. Let us know what you need, and how Serverless AI could potentially help solve a problem for you. We would love to help you write your new Serverless AI application.
952952

953953
## Next Steps
954954

0 commit comments

Comments
 (0)