Skip to content

[FWF Docs]: Fix typos, grammar, and snippets & fix broken links in all developer.fermyon.com #1529

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[FWF Docs]: Fix typos, grammar, and snippets & fix broken links in all developer.fermyon.com #1529

wants to merge 6 commits into from

Conversation

ThorstenHans
Copy link
Contributor

@ThorstenHans ThorstenHans commented Apr 16, 2025 •
edited
Loading

This PR consists of multiple commits:

  • The 1st commit fixes typos in wasm-functions/index
  • The 2nd commit fixes broken links across the docs
  • The 3rd commit fixes typos and snippets in wasm-functions/quickstart
  • The 4th commit fixes the quickstart description shown in wasm-functions/deploy
  • The 5th commit fixes typos, flags, and command outputs in wasm-functions/list-and-inspect
  • The 6th commit fixes the flag users have to specify as part of deleting a particular Spin app from FWF in wasm-functions/delete

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.

@ThorstenHans ThorstenHans changed the title [FWF Docs]: Fix typos and grammar in Index & fix broken links in all developer.fermyon.com [FWF Docs]: Fix typos, grammar, and snippets & fix broken links in all developer.fermyon.com Apr 16, 2025
vdice
vdice approved these changes Apr 16, 2025
View reviewed changes
Copy link
Member

@vdice vdice left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think the https://x.com/lrz/status/1250453967957561344?s=20 url needs to be added to the ignore-list (per the 403) in the broken-links script, otherwise LGTM!

itowlson
itowlson reviewed Apr 16, 2025
View reviewed changes
content/cloud/data-postgres.md
@@ -16,7 +16,7 @@ url = "https://github.com/fermyon/developer/blob/main/content/cloud/data-postgre

## PostgreSQL

[PostgreSQL](https://www.postgresql.org/), is a powerful, open-source object-relational database system that has earned a strong reputation for reliability, robustness and performance. This tutorial will implement a persistent storage solution for Fermyon Cloud, using PostgreSQL. In this tutorial, we will be using [ElephantSQL](https://www.elephantsql.com/plans.html)'s free PostgreSQL service.
[PostgreSQL](https://www.postgresql.org/), is a powerful, open-source object-relational database system that has earned a strong reputation for reliability, robustness and performance. This tutorial will implement a persistent storage solution for Fermyon Cloud, using PostgreSQL. In this tutorial, we will be using ElephantSQL's free PostgreSQL service.
Copy link
Contributor

Choose a reason for hiding this comment

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

ElephantSQL is discontinued, and we shouldn't refer to it. (I thought I had addressed this somewhere but I can't find a PR so... I guess I didn't.) I realise this turns the edit into a rather bigger research and conversion exercise, though, so feel free to raise a separate issue and punt on it.

content/wasm-functions/list-and-inspect.md
@@ -72,8 +72,10 @@ $ spin aka apps info --name hello-fermyon-wasm-functions
<!-- @nocpy -->

```console
Name: hello-fermyon-wasm-functions
Name: hello-fermyon-wasm-functions (25a5fd1e-d476-40fd-bc54-6cee0e846540)
Copy link
Contributor

Choose a reason for hiding this comment

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

No action for now, but I've raised an issue for ID to be a separate field like it is in the JSON

content/wasm-functions/quickstart.md
@@ -437,8 +442,9 @@ If the build fails, check:

* Are you in the `hello-spin` directory?
* Did you successfully [install TinyGo](#install-language-specific-tooling)?
* Are your versions of Go and TinyGo up to date? The Spin SDK needs TinyGo 0.27 or above.
* Are your versions of Go and TinyGo up to date? The Spin SDK needs TinyGo 0.27 or above.
Copy link
Contributor

Choose a reason for hiding this comment

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

@adamreese Is this version requirement still correct? Spin docs says TinyGo 0.35 and Go 1.22. https://spinframework.dev/v3/quickstart#build-your-application

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@itowlson itowlson itowlson left review comments

@vdice vdice vdice approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ThorstenHans @itowlson @vdice