V3 content #1392

itowlson · 2024-10-08T01:05:29Z

This branch tracks work on Spin 3 updates. Initially it's a clone of the Spin 2 docs but this is where we will add / remove / tweak for the v3 stuff.

Content must go through a pre-merge checklist.

Pre-Merge Content Checklist

This documentation has been checked to ensure that:

The title, template, and date are all set
Does this PR have a new menu item (anywhere in templates/*.hbs files) that points to a document .md that is set to publish in the future? If so please only publish the .md and .hbs changes in real-time (otherwise there will be a menu item pointing to a .md file that does not exist)
File does not use CRLF, but uses plain LF (hint: use cat -ve <filename> | grep $'\r' | wc -l and expect 0 as a result)
Has passed bart check
Has been manually tested by running in Spin/Bartholomew (hint: use PREVIEW_MODE=1 and run npm run styles to update styling)
Headings are using Title Case
Code blocks have the programming language set to properly highlight syntax and the proper copy directive
Have tested with npm run test and resolved all errors
Relates to an existing (potentially outdated) blog article? If so please add URL in blog to point to this content.

…pecific references Signed-off-by: itowlson <[email protected]>

Signed-off-by: itowlson <[email protected]>

github-actions · 2024-10-08T01:06:58Z

🚀 preview deployed successfully to Fermyon Cloud and available at https://fermyon-developer-pr-1392-xcy9wthx.fermyon.app

Signed-off-by: itowlson <[email protected]>

itowlson · 2024-10-08T01:15:52Z

@karthik2804 I had to update some logic in page_lang.hbs and spin_main.hbs to tell it to use the v3 sidebar, but I couldn't figure out how to do the if ... else if ... else ... required to handle v3, v2 and v1. Can you advise please? (See 8dd50f8 for the crimes.)

Signed-off-by: itowlson <[email protected]>

Signed-off-by: karthik2804 <[email protected]>

karthik2804 · 2024-10-08T09:16:29Z

@itowlson I opened a PR for that.

fix if else clause in spin_main.hbs

Signed-off-by: itowlson <[email protected]>

Signed-off-by: karthik2804 <[email protected]>

Component dependencies docs

Signed-off-by: itowlson <[email protected]>

Signed-off-by: karthik2804 <[email protected]>

Fix some broken links

update folder structure for llm in spin 3.0

Remove references to HTTP application base

Signed-off-by: itowlson <[email protected]>

Breaking changes info

Application splitting

itowlson · 2024-11-04T20:23:29Z

Is there a way to know why preview deployment is failing? All the logs say is Internal Server Error.

vdice · 2024-11-04T21:07:32Z

Are we continuing the tradition of a cli reference? If so, do we want to add to this PR? Or a follow-up? There is a toolkit that should help with scaffolding it out: https://github.com/fermyon/developer/tree/main/toolkit

itowlson · 2024-11-04T21:11:02Z

No, I want to try getting rid of the CLI reference in its current format because it's laborious to maintain and doesn't seem to add much value. I'd maybe like to add a page that lists the commands and links to the other docs pages that cover them, which will be more stable and I feel more useful. But I can land that in a later PR.

Signed-off-by: itowlson <[email protected]>

vdice

Mostly double-checking if there any applicable docs needing updates for 3.0. Tracking any/all in follow-ups works with me -- especially if we could use other folks to contribute.

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

content/spin/v3/deploying-to-fermyon.md

content/spin/v3/extending-and-embedding.md

content/spin/v3/kv-store-api-guide.md

content/spin/v3/rdbms-storage.md

Signed-off-by: itowlson <[email protected]>

Remove js2wasm from v3 docs

vdice

LGTM pending actual v3 release :)

macolso

Looks good to me. I left a few small suggestions that shouldn't be considered blockers.

Will Fermyon Cloud support 3.0? Either way, I think it would be good to update Cloud documentation accordingly (e.g., adding component dependencies to the Spin Limitations section)

content/spin/v3/writing-apps.md

macolso · 2024-11-06T14:51:35Z

content/spin/v3/writing-apps.md

+
+By default, dependencies do not have access to Spin resources that require permission to be given in the manifest - network hosts, key-value stores, SQLite databases, variables, etc.
+
+If you depend on a component which requires such access, and you trust all the components that you depend on, you can grant them access to the same resources that the 'main' component has by setting the `dependencies_inherit_configuration` flag on the main component:


What do we mean by 'main' component? What if I have a 3 component application and I add another component through dependencies. Does it matter which of the 3 original components I select as 'main'?

'Main' was intended to refer to the component that the dependency is a dependency of. Like the 'main' one in the, uh, component (composition), not the 'main' one in the application. I'll try to rephrase but would welcome ideas!

Okay I think this gets clearer if I talk about the 'component manifest' rather than a 'main' or 'parent' component e.g.

If a component has a dependency which requires resource access, you can grant it by setting the dependencies_inherit_configuration flag in the Spin component manifest:
...
This grants all dependencies access to all resources listed in the Spin component manifest. You should therefore set this only if you trust all dependencies.

I like that approach!

macolso · 2024-11-06T14:52:43Z

content/spin/v3/migration-v2-v3.md

+date = "2023-11-04T00:00:01Z"
+enable_shortcodes = true
+[extra]
+url = "https://github.com/fermyon/developer/blob/main/content/spin/v3/migration-v2-v3.md"


I like promoting the visibility of this by putting it under the "Getting Started" header 👍

macolso · 2024-11-06T14:55:01Z

content/spin/v3/migration-v2-v3.md

+
+---
+
+Most applications will not require changes. The following changes may affect application authors:


Consider adding a link to 3.0 release notes when possible. I could see a reader landing here without being familiar with 3.0 and why they should consider upgrading

Suggested change

Most applications will not require changes. The following changes may affect application authors:

Most applications upgrading to [v3.0](to-do-link-release-notes) will not require changes. The following changes may affect application authors:

Do we know the URL for the 3.0 release notes yet @vdice?

It will be https://github.com/fermyon/spin/releases/v3.0.0

macolso · 2024-11-06T14:57:38Z

content/spin/v3/migration-v2-v3.md

+* Some modules produced by languages with older WASI support may no longer run. This specifically affects WAGI applications
+  compiled with a WASI-SDK version 18 or earlier. See [https://github.com/fermyon/spin/issues/2552](https://github.com/fermyon/spin/issues/2552) for details
+  of the issue and for possible workarounds.
+


Do we want to add a CTA if users are still experiencing issues after the recommended mitigation strategy? Perhaps something like, "If you are affected by one of these changes and are looking for assistance, please reach out on Discord for assistance"

michelleN · 2024-11-07T02:15:17Z

content/cloud/faq.md

 | [Outbound Redis](/spin/rust-components.md#storing-data-in-redis-from-rust-components) | Supported |
+| `wasi-cloud-core` | Not supported |


Should we add a link to wasi cloud core? https://github.com/WebAssembly/wasi-cloud-core

michelleN · 2024-11-07T02:15:56Z

content/cloud/faq.md

 | [Outbound Redis](/spin/rust-components.md#storing-data-in-redis-from-rust-components) | Supported |
+| `wasi-cloud-core` | Not supported |
+| **Features** |
+| Component dependencies | Not supported |


Linking to the docs rather than the SIP but good call 👍

michelleN · 2024-11-07T02:22:27Z

content/spin/v3/contributing-spin.md

+
+## Code of Conduct
+
+First, any contribution and interaction on any Fermyon project MUST follow our


Suggested change

First, any contribution and interaction on any Fermyon project MUST follow our

First, any contribution and interaction on the Spin project MUST follow our

michelleN · 2024-11-07T02:22:48Z

content/spin/v3/contributing-spin.md

+## Code of Conduct
+
+First, any contribution and interaction on any Fermyon project MUST follow our
+[code of conduct](https://www.fermyon.com/code-of-conduct). Thank you for being


Suggested change

[code of conduct](https://www.fermyon.com/code-of-conduct). Thank you for being

[code of conduct](https://github.com/fermyon/spin/blob/main/CODE_OF_CONDUCT.md). Thank you for being

Signed-off-by: itowlson <[email protected]>

itowlson added 2 commits October 8, 2024 11:55

v3 content baseline: copy v2 content, update links to v3, remove v2-s…

e081201

…pecific references Signed-off-by: itowlson <[email protected]>

Typo and spelling fixes from trying to calm the spell checker

6a52c81

Signed-off-by: itowlson <[email protected]>

itowlson added the doNotMergeYet label Oct 8, 2024

itowlson mentioned this pull request Oct 8, 2024

V3 content #1391

Closed

9 tasks

Enable testing viewing of v3 (breaks v2 for now!)

8dd50f8

Signed-off-by: itowlson <[email protected]>

itowlson and others added 4 commits October 8, 2024 14:53

Add v3 to version drop-down

d810bb6

Signed-off-by: itowlson <[email protected]>

Remove references to HTTP application base

90a2695

Signed-off-by: itowlson <[email protected]>

Component dependencies docs

fb42715

Signed-off-by: itowlson <[email protected]>

fix if else clause in spin_main.hbs

e1025f2

Signed-off-by: karthik2804 <[email protected]>

itowlson added 2 commits October 9, 2024 08:14

Merge pull request #1395 from karthik2804/v3_sidebar

10eac4f

fix if else clause in spin_main.hbs

Add if-elseif-else fix to page_lang.hbs

7aa74af

Signed-off-by: itowlson <[email protected]>

itowlson linked an issue Oct 9, 2024 that may be closed by this pull request

Spin 3.0 Documentation Toggle #1383

Closed

karthik2804 and others added 11 commits October 15, 2024 14:03

update folder structure for llm in spin 3.0

35a9207

Signed-off-by: karthik2804 <[email protected]>

Merge pull request #1393 from itowlson/component-dependencies

77ccb29

Component dependencies docs

Fix some broken links

ae3b1ae

Signed-off-by: itowlson <[email protected]>

fix review comments

ec9dfcb

Signed-off-by: karthik2804 <[email protected]>

Merge pull request #1399 from itowlson/fix-cli-reference-links

92900d7

Fix some broken links

Merge pull request #1398 from karthik2804/update_llm_docs

c42b27a

update folder structure for llm in spin 3.0

Merge pull request #1394 from itowlson/remove-http-base

952ccf1

Remove references to HTTP application base

Application splitting

724f93d

Signed-off-by: itowlson <[email protected]>

Breaking changes info

836b1af

Signed-off-by: itowlson <[email protected]>

Merge pull request #1396 from itowlson/whats-new-and-breaking-changes-v3

fb3d095

Breaking changes info

Merge pull request #1400 from itowlson/app-splitting

90f3666

Application splitting

itowlson removed the doNotMergeYet label Nov 4, 2024

itowlson marked this pull request as ready for review November 4, 2024 20:19

itowlson requested review from vdice and michelleN November 4, 2024 20:19

itowlson requested a review from macolso November 4, 2024 20:19

Work around cloud issue with two triggers pointing to same component

51bacee

Signed-off-by: itowlson <[email protected]>

vdice reviewed Nov 4, 2024

View reviewed changes

itowlson added 2 commits November 5, 2024 11:27

Remove js2wasm from v3 docs

3ad02bc

Signed-off-by: itowlson <[email protected]>

Typo fixes

5b70d2e

Signed-off-by: itowlson <[email protected]>

vdice mentioned this pull request Nov 4, 2024

v3 updates to Extending and Embedding Spin #1411

Open

vdice added the spin-3.0 Changes arriving in Spin 3.0 label Nov 4, 2024

Merge pull request #1410 from itowlson/exterminate-js2wasm

3d06a63

Remove js2wasm from v3 docs

vdice approved these changes Nov 4, 2024

View reviewed changes

macolso approved these changes Nov 6, 2024

View reviewed changes

michelleN reviewed Nov 7, 2024

View reviewed changes

Updates from review

beac43f

Signed-off-by: itowlson <[email protected]>

itowlson force-pushed the v3-content branch from e11adec to beac43f Compare November 7, 2024 02:35

vdice mentioned this pull request Nov 7, 2024

Spin 3.0 Release checklist fermyon/spin#2899

Closed

10 tasks

vdice merged commit 328ecae into main Nov 8, 2024
3 checks passed

vdice deleted the v3-content branch November 8, 2024 01:13

vdice mentioned this pull request Nov 8, 2024

JS SDK updates - remove js2wasm plugin mention #1409

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V3 content #1392

V3 content #1392

itowlson commented Oct 8, 2024

github-actions bot commented Oct 8, 2024

itowlson commented Oct 8, 2024

karthik2804 commented Oct 8, 2024

itowlson commented Nov 4, 2024

vdice commented Nov 4, 2024

itowlson commented Nov 4, 2024

vdice left a comment

vdice left a comment

macolso left a comment

macolso Nov 6, 2024

itowlson Nov 6, 2024

itowlson Nov 6, 2024

macolso Nov 7, 2024

macolso Nov 6, 2024

macolso Nov 6, 2024

itowlson Nov 6, 2024

vdice Nov 6, 2024

macolso Nov 6, 2024

michelleN Nov 7, 2024

michelleN Nov 7, 2024

itowlson Nov 7, 2024

michelleN Nov 7, 2024

michelleN Nov 7, 2024


		By default, dependencies do not have access to Spin resources that require permission to be given in the manifest - network hosts, key-value stores, SQLite databases, variables, etc.

		If you depend on a component which requires such access, and you trust all the components that you depend on, you can grant them access to the same resources that the 'main' component has by setting the `dependencies_inherit_configuration` flag on the main component:


		---

		Most applications will not require changes. The following changes may affect application authors:

	Most applications will not require changes. The following changes may affect application authors:
	Most applications upgrading to [v3.0](to-do-link-release-notes) will not require changes. The following changes may affect application authors:

		\| [Outbound Redis](/spin/rust-components.md#storing-data-in-redis-from-rust-components) \| Supported \|
		\| `wasi-cloud-core` \| Not supported \|

	\| Component dependencies \| Not supported \|
	\| [Component dependencies](https://github.com/fermyon/spin/blob/main/docs/content/sips/020-component-dependencies.md) \| Not supported \|


		## Code of Conduct

		First, any contribution and interaction on any Fermyon project MUST follow our

	[code of conduct](https://www.fermyon.com/code-of-conduct). Thank you for being
	[code of conduct](https://github.com/fermyon/spin/blob/main/CODE_OF_CONDUCT.md). Thank you for being

V3 content #1392

V3 content #1392

Conversation

itowlson commented Oct 8, 2024

Pre-Merge Content Checklist

github-actions bot commented Oct 8, 2024

itowlson commented Oct 8, 2024

karthik2804 commented Oct 8, 2024

itowlson commented Nov 4, 2024

vdice commented Nov 4, 2024

itowlson commented Nov 4, 2024

vdice left a comment

Choose a reason for hiding this comment

vdice left a comment

Choose a reason for hiding this comment

macolso left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment