Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V3 content #1392

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

V3 content #1392

wants to merge 24 commits into from

Conversation

itowlson
Copy link
Contributor

@itowlson itowlson commented Oct 8, 2024

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.

@itowlson itowlson mentioned this pull request Oct 8, 2024
9 tasks
Copy link

github-actions bot commented Oct 8, 2024

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

@itowlson
Copy link
Contributor Author

itowlson commented Oct 8, 2024

@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.)

@karthik2804
Copy link
Contributor

@itowlson I opened a PR for that.

@itowlson itowlson linked an issue Oct 9, 2024 that may be closed by this pull request
@itowlson itowlson marked this pull request as ready for review November 4, 2024 20:19
@itowlson itowlson requested a review from macolso November 4, 2024 20:19
@itowlson
Copy link
Contributor Author

itowlson commented Nov 4, 2024

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

@vdice
Copy link
Member

vdice commented Nov 4, 2024

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
Copy link
Contributor Author

itowlson commented Nov 4, 2024

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.

Copy link
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
content/spin/v3/deploying-to-fermyon.md Outdated Show resolved Hide resolved
content/spin/v3/extending-and-embedding.md Outdated Show resolved Hide resolved
content/spin/v3/kv-store-api-guide.md Outdated Show resolved Hide resolved
content/spin/v3/rdbms-storage.md Outdated Show resolved Hide resolved
Signed-off-by: itowlson <[email protected]>
@vdice vdice added the spin-3.0 Changes arriving in Spin 3.0 label Nov 4, 2024
Copy link
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM pending actual v3 release :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spin-3.0 Changes arriving in Spin 3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spin 3.0 Documentation Toggle
3 participants