fermyon / developer Goto Github PK

It would be really cool if the code renderer for our docs website allowed a toggle we can use to show instructions / code samples for multiple platforms / languages (like Linux and Windows instructions, or how to write a component in multiple programming languages).

This would be similar to:

(source: Cloud Run docs)

Implement the top navigation bar design

For existing references to *.fermyon.dev, we need to redirect to the new home in developer.fermyon.com.

At present the sidebar (using cloud sidebar as an example) appears correctly when on the cloud/index page.

However the sidebar disappears when a user clicks on a different page i.e. when visiting the cloud/cli-reference/ page.

The static/image/arrowexternal.svg icon is a temporary solution. We need a designed file for this, and the corresponding css/html.

Consider the following code block that shows a shell command and its output:

The "copy" button will copy the entire contents, whereas the only thing you need is the command itself.

Is there a way we could have some logic (perhaps a shortcode?) where we could distinguish between a command and its output?

Once we release this portal, we need to freeze/remove the Spin repo docs.

• Remove docs
• #4
• Spin readme.md needs an update with logo and text similar to quickstart

The support article currently states that users can submit issues on GitHub. We need to agree on whether we want to do that, and make sure the repo link in the article is correct.

https://www.notion.so/fermyon/Fermyon-Cloud-c00d8527e25442f88c15506e35210492

Currently uses both bullet points and numbering.

https://www.notion.so/fermyon/Working-with-data-maybe-files-to-be-part-of-this-5b68a817f75f4b649a5112805dbb7e6e

https://github.com/fermyon/cloud/issues/847

https://github.com/fermyon/cloud/issues/822#issuecomment-1270710772

Currently, the top bar with the project titles feels cluttered on mobile devices and there is no space to add additional projects. We could make the menu convert into a dropdown menu option for mobile devices.

The top navigation bar should indicate what project/product you are looking at right now.

First I want to thank you for putting out this programming language guide for Wasm and it helped me a lot to learn what PLs support WASI environment. When I first read the guide, I was confused about the "Other" column in the top 20 languages. I later figured it out it meant non-browser environments. But this is a bit vague. Do you mean host environments with an operating systems like Windows or Unix? I would recommend to make it more specific, probably by saying these languages could work in Linux OS.

Another note is that the "Wasm languages" and "Other Notable Languages" have a section where the "Other" column is replaced with "CLI". Does "CLI" mean the same thing as "Other" in the previous section?

This is entirely my preference that can be safely ignored.
But to me it seems the copy button is too big.

That's it, that's the issue.
Feel free to close.

Code blocks do not have a copy icon, so you can easily copy the whole content to your clipboard to quickly paste it into a terminal.

The code block is also not aligned on the right margin with the paragraphs.

The Markdown linter currently fails because of an empty link as pointed out by the error

content/spin/architecture.md:61:47 MD042/no-empty-links No empty links [Context: "[pre-instantiate]()"]

I am unsure of the proper link that it needs to be pointing at.

The AssemblyScript section in wasm-languages currently references as-wasi. We can go ahead and update these docs as per the following information.

as-wasi
as-wasi is a third-party library that implemented WASI.
as-wasi got superseded by import wasi from the standard library.
as-wasi can still be considered current and is used in a few recognisable projects.

import wasi
import wasi from the standard library is no longer the default.

wasi-shim
Created by AssemblyScript, wasi-shim is now what we may know as the best alternative to import wasi (from the standard library) moving forward.

From what I can see there are a couple of spots possibly worth updating:

• https://www.fermyon.com/wasm-languages/assemblyscript (code examples that use as-wasi can have a secondary example using wasi-shim).
• https://www.fermyon.com/wasm-languages/webassembly-language-support (perhaps a little footnote to explain WASI support is via wasi-shim, but to be fair I guess we don't have a footnote that says Rust WASI support is via wasm32-wasi so perhaps keep it "as-is" simple on this page). Or, perhaps use the notes section on Rust and AssemblyScript to paste wasm32-wasi and wasi-shim in respectively.

Implement the landing page design

We either need a Google analytics ID for this site in config/site.toml. This could be an opportunity to try out https://plausible.io/.

Let's change the 'Fermyverse' name in the search box to "Fermyon Developer Home" to keep it consistent across the site.

https://www.notion.so/fermyon/Deploy-Bartholomew-to-Fermyon-Cloud-06c623d3d83a4026acc71c0f14b19707

Looks like it should be fixed in the Fermyon Style sheet:

fermyon-type.scss

ul, ol, dl, p, blockquote {
        margin: 1.67rem 0;
        font-size: 1rem;
        max-width: 800px;
}

    pre {
        margin: 1.333rem 0;
        max-width: 100%; <-- should be 800px like the above
        position: relative;
    }

https://www.notion.so/fermyon/Networking-75e5cb7a3c31455f9f78c70d5ed1ea1b

Page templates and scripts to generate paths are currently duplicated per project/product. Let's see if this can be consolidated.

It's probably important to include some supporting information about Spin architecture in "Using Spin" section. As an aside, I've included another issue about restructuring the sections in fermyon/spin#264

I needed a reference to Spin SDKs and there is no good article in the Spin documentation to use.

We should create an article describing the Spin SDKs conceptually, which have and their support, and other SDKs we know about.

Also we should probably do a new commit to add all the required annotations for the codeblocks across the repository (For removing copy button and formatted copy for the shell code blocks)

Originally posted by @karthik2804 in #34 (review)

https://www.notion.so/fermyon/Something-with-data-in-the-Fermyon-Cloud-8635031624a845bd9425d6ae14a934cc

Crea a PR template with a content check-list.

These docs are going to be out of date with the upcoming Spin core refactor. We should think about how we want to update this docs page or whether we should delete it until we have a more cohesive trigger plugin story.

Forest functional programming language: https://github.com/forest-lang/forest-compiler

Using a <details> element does not render in a nice way, and you cannot use links inside the element.

You can now run spin using the command `./spin`

<details>
  <summary>Learn more</summary>
  The [Spin quickstart](https://developer.fermyon.com/spin/quickstart) is a good place to start, to learn more about Spin.
</details>

Renders like this

Currently, if the Redis instance has a password set in redis.conf, the Spin trigger has no way of passing that password.

ref https://redis.io/topics/security#authentication-feature
ref fermyon/spin#181
ref fermyon/spin#160

https://www.notion.so/fermyon/Using-VS-Code-6c4767a3447842aa964b5cf6d87c1d98

It would be brilliant to be able to link to headings instead of just being able to link to whole pages.
Not sure what this entails; need to have a quick research/look. Putting in this issue so we can make this happen soon.

Ensure that this new domain has a top level robots.txt file and a site map.

Ensure that WebCrawler knows to index this new developer.fermyon.com content by adding an allow all to robots.txt file.

At the same time, ensure that the top level robots.txt file from the old x.fermyon.dev domain disallows the WebCrawler.

Broken links in developer portal as we are using / at the end of href link even when it is pointing to a file.

e.g.

in templates/spin_sidebar.hbs

Steps to reproduce:

1. go to https://canary.developer.fermyon.com/
2. Click on Spin in top navigation
3. Click on 'Quickstartin left navigation. Notice it takes you tohttps://canary.developer.fermyon.com/spin/quickstart/` with a slash at the end.
4. Scroll to the end and click on Rust link
5. It takes you to https://canary.developer.fermyon.com/spin/quickstart/rust-components which is incorrect.

Now if you just remove last / from https://canary.developer.fermyon.com/spin/quickstart/, and click on Rust link again. Notice it works.

in spin/* pages, the link to other pages under spin is currently broken. e.g.

• go to http://localhost:3000/spin/index
• scroll to the end
• click on take Spin for a spin
• observe the link is broken

noticed that its broken similarly in other pages as well.

As we release this website and remove docs from the Spin repo, we should make sure that the links to the contribution guide and SIPs are updated in spin_sidebar.hbs

The Redis examples do not have any of the use statements in them, which means the reader has to go figure out which packages to use.

Trial accounts are restricted to 5 apps, and 1 channel per app, for example. These restrictions should be documented so that the user clearly knows what is the expected behaviour of the platform.

Implement action workflows for tests, deployment to canary and production deployments

Kaitlin will come up with a design for this box. Make sure to use the right font 'sen'

https://www.notion.so/fermyon/Deployment-and-Bindles-c262d6be4a4249ae9ea9ed17fbc90034

@karthik2804 has found a solution to implement search functionality, which is easy to implement.
https://docsearch.algolia.com/
We can look at implementing this soon.