Git Product home page Git Product logo

wasmcloud-dev-site's Introduction

wasmCloud.dev

The previous home for wasmCloud documentation! After our documentation epic, all documentation source code is now served in the wasmcloud.com-dev repository and is hosted at https://wasmcloud.com. This was done in the interest of keeping all of our content in one place.

If you have any links that refer to https://wasmcloud.dev, they will automatically redirect to https://wasmcloud.com.

wasmcloud-dev-site's People

Contributors

autodidaddict avatar billyoung avatar brooksmtownsend avatar byblakeorriver avatar jordan-rash avatar l-mb avatar liamrandall avatar matsbror avatar matthewtgilbride avatar mattwilkinsonn avatar mydnicq avatar ricochet avatar ruiramos avatar stevelr avatar thomastaylor312 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

wasmcloud-dev-site's Issues

Community Meeting - Wednesday, March 30th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video: https://youtu.be/-CT7YyO6vn4
Tweet:

Demos:

Minutes:

Link references:

Community Meeting - Wednesday, March 9th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video: https://youtu.be/kuOqbaIhSy0
Tweet:

Demos:

Minutes:

Link references:

Community Meeting - Wednesday, May 25th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

TinyGo Code Generation Demo

Minutes:

Back from WasmDay Updates
wasmCloud Blog Post Released

Link references:

Community Meeting - Wednesday, April 27th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

Updated Pet Clinic Demo - UI Actor
Create Your First Actor Demo
GHCR Integration
TinyGo Actor Demo

Minutes:

Community Announcements
New WADM Documentation/RFC

Link references:

Update `wash` linking command

In the actor documentation the command for using wash to create a link looks like this:

wash ctl link ACTOR_ID VAG3QITQQ2ODAOWB5TTQSDJ53XK3SHBEIFNK4AYJ5RKAX2UNSCAPHA5M wasmcloud:httpserver address=0.0.0.0:8087

It should have a put subcommand like this:

wash ctl link put ACTOR_ID VAG3QITQQ2ODAOWB5TTQSDJ53XK3SHBEIFNK4AYJ5RKAX2UNSCAPHA5M wasmcloud:httpserver address=0.0.0.0:8087

Add shutdown section

There are a few different ways to shutdown a wasmCloud host. If launched from the distillery release, it should be done with ./bin/wasmcloud_host stop. If launched with iex, it can either be closed with CTRL+c a, CTRL+c CTRL+c, or with HostCore.Host.shutdown. The HostCore.Host.shutdown is the preferred method as it allows providers to cleanly shutdown.

We should add this to our documentation to avoid scenarios where providers are dangling (the fix is to find providers, I usually do ps aux | grep VA to find the process, and then kill <pid>

Community Meeting - Wednesday, April 13th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video: https://youtu.be/Wih95FAfQz4
Tweet:

Demos:

Minutes:

Link references:

Explicitly document the process of configuring, joining, and maintaining a lattice

Some things that should be in this new documentation:

  • How a lattice is formed
  • How to create the cluster key(s) used for the hosts within a lattice
  • Authentication options for NATS in the lattice
  • How to purge the distributed cache (jetstream)

This new documentation should have a step-by-step guide to creating a lattice of 3 hosts, illustrating all of the web UI/CLI tool commands required to manage this.

Troubleshooting call-for-feedback

Have you run into an error with wasmCloud? Was it difficult to track down the source of the problem after you saw an error in the wasmCloud host logs? Well this thread is for you!

Please leave feedback on any scenarios that you've run into, with as much detail that you can remember. Bonus points if this is an issue that you resolved on your own. We'd love to improve our documentation troubleshooting guides to include common use cases and your feedback can make that even better than it is today.

Community Meeting - Wednesday, May 4th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

Minutes:

Link references:

Advanced wasmCloud application examples

Our documentation covers the local case very well, but when we get into the following domains we could use more information in the dev docs.

  • Leaf node configuration with NGS (jetstream hub/spoke domains)
  • Controlling a wasmCloud host from anywhere (hitting washboard, wash contexts)
  • Configuring host_configs and wash contexts for easy control of complicated configurations
  • Remote/private OCI registries

Documentation on health checks

health checks

  • How often are they sent
  • How long does an actor or provider get to respond before it's considered failed?
  • What does host do when it receives a failure? Does it try again, or is a single failure considered fatal?

shutdown

  • if a provider health check fails, will it still get a shutdown message before its process is terminated?

  • how long can a provider take to shutdown before it's process is killed?

restart

  • what is the sequence of operations & messages for restarting a failed actor or provider? (Including link additions/removals, etc)

  • what is the relative timing between a failing provider shutdown and new provider starting? Can there be periods of time when they are both running? Can there be periods of time when neither are running?

roadmap

Are there plans in the roadmap, or other ideas, for improving the health check protocols and processes?

document requirement for bash-compatible shell

the makefiles in the examples project use mult-line commands such as
the wash claims sign command:

wash claims sign target/wasm32-unknown-unknown/release/hello.wasm \
         -c wasmcloud:httpserver  \
        --name hello --ver 0.1.2 --rev 0 \
        --call-alias wasmcloud_example_hello \
        --destination build/hello_s.wasm

The \ used for line continuation doesn't work in windows 10 Powershell, so the command make fails. If you start bash (or the shell from the "Git bash" package), and then run make, it works.

Actor troubleshooting doc

In the App Development section of our documentation, developers would benefit greatly from a "commonly seen errors" section.

This section could provide common errors encountered during wasmcloud actor development. Some that come to mind are:

  1. Link not correctly configured from actor to provider
  2. panic in actor module
  3. JSON serialization failure (happens commonly when manually calling an actor)
  4. Suggestions for Malformed response from actor

A document like this would not attempt to be a comprehensive resource for all actor errors. What this would be useful for is to give developers a starting off point with common causes of these errors, and if they have not made use of the logging provider then a resource that points them to use that, as stdout is not viewable from an actor module.

Community Meeting - Wednesday, March 16th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video: https://youtu.be/9jrKf2VCQmI
Tweet:

Demos:

Minutes:

Link references:

wapc spec and new language guidelines

Thanks for the recent update of the wasmcloud.dev site. Much appreciated.

It would be great with some rudimentary documentation (perhaps through examples) on wapc and how to add new language bindings. In particular I am interesting in adding C++ as an actor language.

Add disclaimer to hot reloading re: Docker

Running wasmCloud in a Docker container works great, though for hot reloading we require access to the filesystem to watch the actor. When running in Docker, the filesystem is not the user's filesystem, so attempts to run an actor from the filesystem will fail with an enoent error.

  • First: we should add a disclaimer to the top of https://wasmcloud.dev/app-dev/create-actor/update/ noting that this won't work in Docker unless you use a file mount.
  • Second: we should add a small section for how to properly mount the actor build/ directory to a directory on the container, then hot reloading should function as intended. This should be verified to work on different operating systems (Docker Desktop is different on Mac/Linux/Windows)

UI Bug: copy button is added to code tags

Ui ads <span class="copy-to-clipboard">copy</span> element to <code> tags when navigating via links (usually one but sometimes more than one) and these buttons get multiplied when using forward and backward buttons and eventually page becomes unresponsive.

It happens in Firefox 86.0 (64-bit) and Chromium Version 89.0.4389.90 (Official Build) snap (64-bit).

Here is an image and screen captures. At the end of the second video, you can see console log. I also added parts of it below:

wasmcloud-console

bug.mp4
wascloud-console.mp4
DevTools failed to load SourceMap: Could not load content for https://wasmcloud.dev/plugins/bootstrap/bootstrap.min.js.map: HTTP error: status code 404, net::ERR_HTTP_RESPONSE_CODE_FAILURE
You are loading Turbolinks from a <script> element inside the <body> element. This is probably not what you meant to do!

Load your application’s JavaScript bundle inside the <head> element instead. <script> elements in <body> are evaluated with each page change.

For more information, see: https://github.com/turbolinks/turbolinks#working-with-script-elements

——
Suppress this warning by adding a `data-turbolinks-suppress-warning` attribute to: <script src="https://wasmcloud.dev/plugins/turbolinks/turbolinks.js"></script>
(anonymous) @ turbolinks.js:6
(anonymous) @ turbolinks.js:6
(anonymous) @ turbolinks.js:6
(anonymous) @ turbolinks.js:6
(anonymous) @ turbolinks.js:6

Enhance the `tab` partial

In the current site when we place content inside a tab partial, it uses a specific style and creates a div. What we can't do is use the triple-backtick to enable syntax highlighting or other goodies inside that content. Right now, we're forced to use the preformatted style sheet. Further, we can't even include blank lines inside the tab because it screws up the formatting.

When this is done and working, we should be able to have tabs that include syntax highlighted code samples that support multiple blank lines and potentially other content above and below the sample.

Community Meeting - Wednesday, May 18th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

Minutes:

Link references:

Community Meeting - Wednesday, March 2nd

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video: https://youtu.be/FbuFpi8naRk
Tweet:

Demos:

Minutes:

Link references:

Inconsistencies in provider tutorial

There a few small inconsistencies in interface and crate names in the provider tutorial and examples which makes the experience bumpy. It would also be good to have some explanation as to what till fill in when doing the wash new interface generation.

Document lattice protocols

Fully document the protocols used by lattice:

  • RPC (actor-actor, actor-provider)
  • Control Interface

These should be documented in a language agnostic fashion in an appendix on wasmcloud.dev

Getting started section needs to be completed

This is the section of the docs right beneath "installation", and this is in most cases going to be a developer's first exposure to wasmCloud. This section of the docs should walk the developer through their first experience with wash by having them fire up the repl and go through the simple demo script - start an actor, start a provider, link the actor to the provider, curl the endpoint, and then finish up with a taste for advanced techniques by doing a direct call on the actor.

Update `curl` commands for Windows

The curl commands as they exist in the docs will not work on Windows (as it isn't actually curl it is calling). Curl commands need a flag and all addresses prefaced by http. Any examples with curl should also have a powershell specific example where the command looks like this:

curl -UseBasicParsing http://<rest of url>

Wrong query statements in `customizing the actor`

On page Customizing the actor, the following query statements:

curl 'localhost:8087/?name=Alice,msg=hello'
curl 'localhost:8087/?name=Bob,msg=bye'
curl 'localhost:8087/?name=Carol,msg=hey'

are wrong and should be:

curl 'localhost:8087/?name=Alice&msg=hello'
curl 'localhost:8087/?name=Bob&msg=bye'
curl 'localhost:8087/?name=Carol&msg=hey'

Community Meeting - Wednesday, April 20th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

Minutes:

wash 0.10.0 Released (breaking change)
Community Callout
"Running Your UI on wasmCloud" Blog Post
TinyGo Actor Support
Future CodeGen Discussion

Link references:

Community Meeting - Wednesday, May 11th

This issue should only be closed by a commit to the site with the minutes and
artifacts for easy referencing

Attendance

ToDo Items

  • YouTube Video
  • Twitter Post
  • Reddit Post
  • LinkedIn Post
  • Update site with minutes

Artifacts

YouTube Video:
Tweet:

Demos:

GHCR + Github Action Demo

Minutes:

wasmCloud @ KubeCon Updates
wasmCloud Training Site Released

Link references:

Live update / local registry needs

  1. WASMCLOUD_OCI_ALLOWED_INSECURE needs to be set in order for the user to actually start actors/providers from the local registry
  2. The make update command either needs to be commented back in for the common makefile, or we need to provide a live update command that can be run manually. I'd lean towards the former, as we should provide the make update functionality

We could potentially mitigate 1 if we can find a way to serve the localhost registry over https, but that would only be worth it if we can easily provide that as a part of the docker compose, not worth it if multiple certificates are required.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.