Move workspace explanation out of aside #1550
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Caleb Schoepp <[email protected]>
9 tasks
itowlson
approved these changes
May 26, 2025
| Your local workspace can be linked to an application running in _Fermyon Wasm Functions_. This is a convenience so that you don't always have to specify the `--app-name` when running commands. | ||
|
|
||
| {{ details "What is a workspace?" "A workspace is a directory on your local machine that contains the Spin application code and manifest file. It is where you develop and test your application before deploying it to _Fermyon Wasm Functions_. Any child directory of where the Spin manifest is located is also considered part of the workspace." }} | ||
| A workspace is a directory on your local machine that contains the Spin application code and manifest file. It is where you develop and test your application before deploying it to _Fermyon Wasm Functions_. Any child directory of where the Spin manifest is located is also considered part of the workspace. |
There was a problem hiding this comment.
I think we should add a mention about the manifest having to be named exactly spin.toml, e.g.
> Fermyon Wasm Functions is more opinionated than the Spin command line. The Spin application manifest for a workspace _must_ be called `spin.toml`.
Happy to tinker with this as a separate PR if you just want to move on though!
There was a problem hiding this comment.
Good feedback. Yeah, how about we merge this as a small improvement for now.
I'd love if you follow up and prettify/clarify the docs I wrote. Happy to review.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Content must go through a pre-merge checklist.
Pre-Merge Content Checklist
This documentation has been checked to ensure that:
title,template, anddateare all settemplates/*.hbsfiles) that points to a document.mdthat is set to publish in the future? If so please only publish the.mdand.hbschanges in real-time (otherwise there will be a menu item pointing to a.mdfile that does not exist)cat -ve <filename> | grep $'\r' | wc -land expect 0 as a result)bart checkPREVIEW_MODE=1and runnpm run stylesto update styling)npm run testand resolved all errors