make project descriptions more beginner friendly #272
Conversation
| @@ -5,7 +5,8 @@ title: SpinKube | |||
| {{< blocks/cover title="Hyper-efficient serverless on Kubernetes, powered by WebAssembly." | |||
| image_anchor="top" height="full" >}} <a class="btn btn-lg btn-primary me-3 mb-4" href="/docs"> Get | |||
| Started <i class="fas fa-arrow-alt-circle-right ms-2"></i> </a> | |||
| <p class="lead mt-5">SpinKube is an open source project that streamlines developing, deploying and operating WebAssembly workloads in Kubernetes - resulting in delivering smaller, more portable applications and incredible compute performance benefits.</p> | |||
| <p class="lead mt-5">SpinKube is an open source, Kubernetes native project that streamlines developing, | |||
There was a problem hiding this comment.
Option to use the word stack if folks like that better.
| <p class="lead mt-5">SpinKube is an open source, Kubernetes native project that streamlines developing, | |
| <p class="lead mt-5">SpinKube is an open source, Kubernetes native project stack that streamlines developing, |
michelleN
requested review from
devigned,
Mossaka,
kate-goldenring and
ThorstenHans
content/en/_index.md
Outdated
| App Custom Resource Definitions (CRDs). Spin Operator watches SpinApp Custom Resources e.g. Spin app | ||
| image, replicas, schedulers and other user-defined values and realizes the desired state in the | ||
| Kubernetes cluster. Spin Operator introduces a host of functionality such as resource-based scaling | ||
| [**Containerd Shim Spin**](https://github.com/spinkube/containerd-shim-spin) provides a containerd shim implementation for running Spin workloads which is then used as a runtime class within Kubernetes for |
There was a problem hiding this comment.
I think we can remove the mention of runwasi
There was a problem hiding this comment.
Tried to re-word and realized I kind of like the runwasi mention there. If a user clicks the link, they'll see the description "Facilitates running Wasm / WASI workloads managed by containerd" and that creates a link in understanding between this project and the WASI implementation for k8s. You're the maintainer though so I'm happy to remove it if you'd prefer that.
There was a problem hiding this comment.
The reason I think we should remove the runwasi mention is that it's not important for users to know what libraires containerd-shim-spin is using or how the shim is implemented. It's more important to highlight what it is doing - a shim for running Spin workloads managed by Containerd.
There was a problem hiding this comment.
agreed. took another stab at it.
michelleN
force-pushed
the
homepage
branch
2 times, most recently
from
b486719 to
29082e4
Compare
Signed-off-by: Michelle Dhanani <michelle@fermyon.com>
| trigger designed specifically for Spin. It enables seamless integration between Spin and MQTT-based | ||
| systems, allowing you to automate workflows and trigger actions based on MQTT messages. | ||
| [**Spin kube plugin**](https://github.com/spinkube/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI | ||
| thats aim to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes. |
There was a problem hiding this comment.
| thats aim to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes. | |
| thats aims to ease the experience of scaffolding and inspecting SpinApp resources in Kubernetes. |
| [**Spin kube plugin**](https://github.com/spinkube/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI | ||
| thats aim to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes. | ||
|
|
||
| [**Spin Trigger MQTT**](https://github.com/spinkube/spin-trigger-mqtt/) trigger enables seamless integration |
There was a problem hiding this comment.
I personally find it confusing to list this trigger since there are more triggers than this one that the shim supports. Yes, this trigger lives in the SK org but i dont think we need to document it here
Co-authored-by: Kate Goldenring <kate.goldenring@gmail.com> Signed-off-by: Michelle Dhanani <michelle@fermyon.com>
No description provided.