From c52e1a5c15bd9b1094e5ae7a86a831a0ee432692 Mon Sep 17 00:00:00 2001 From: "Jiaxiao (mossaka) Zhou" Date: Thu, 16 Jan 2025 18:00:46 +0000 Subject: [PATCH 1/3] README: add minimal node version requirement to build the docs locally Signed-off-by: Jiaxiao (mossaka) Zhou --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 25e3cb57..b8e2d96d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This project contains the source code for spinkube.dev. ## Running Locally -Make sure you have [Node.js](http://nodejs.org/) and [Go](https://golang.org) installed. +Make sure you have [Node.js](http://nodejs.org/) (v14 or later) and [Go](https://golang.org) installed. Clone this repository and run the following commands: From e6ac49f9aac5a5dce5ce5892defccff307ca3ab4 Mon Sep 17 00:00:00 2001 From: "Jiaxiao (mossaka) Zhou" Date: Thu, 16 Jan 2025 18:00:59 +0000 Subject: [PATCH 2/3] _index.md: re-order the projects and minor word tweaks 1. rename containerd spin shim -> containerd shim spin for consistency 2. Move the Spin operator to the top of the projects page 3. Rename 'Overview' to 'SpinKube Projects' 4. Remove over-explaination of projects Signed-off-by: Jiaxiao (mossaka) Zhou --- content/en/_index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/en/_index.md b/content/en/_index.md index 90b3349c..c53c492b 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -14,7 +14,7 @@ deploying, and operating WebAssembly (Wasm) workloads in Kubernetes - resulting {{% blocks/lead color="secondary" %}} SpinKube combines the Spin operator, containerd Spin shim, and the containerd shim Spin, and the runtime class manager (formerly KWasm) open source projects with contributions from Microsoft, SUSE, Liquid Reply, and Fermyon. By running applications at the Wasm abstraction layer, SpinKube gives @@ -29,6 +29,12 @@ Kubernetes. ### Overview +[**Spin Operator**](https://github.com/spinkube/spin-operator/) is a Kubernetes operator that enables +deploying and running Spin applications in Kubernetes. It houses the SpinApp and SpinAppExecutor CRDs +which are used for configuring the individual workloads and workload execution configuration such as +runtime class. Spin Operator introduces a host of functionality such as resource-based scaling, +event-driven scaling and much more. + [**Containerd Shim Spin**](https://github.com/spinkube/containerd-shim-spin) provides a shim for running Spin workloads managed by containerd. The Spin workload uses this shim as a runtime class within Kubernetes enabling these workloads to function similarly to container workloads in Pods in Kubernetes. @@ -38,12 +44,6 @@ automates and manages the lifecycle of containerd shims in a Kubernetes environm like installation, update, removal, and configuration of shims, reducing manual errors and improving reliability in managing WebAssembly (Wasm) workloads and other containerd extensions. -[**Spin Operator**](https://github.com/spinkube/spin-operator/) is a Kubernetes operator that enables -deploying and running Spin applications in Kubernetes. It houses the SpinApp and SpinAppExecutor CRDs -which are used for configuring the individual workloads and workload execution configuration such as -runtime class. Spin Operator introduces a host of functionality such as resource-based scaling, -event-driven scaling and much more. - [**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. From 375e80ce10377f6111f085043f8757ab49079f3f Mon Sep 17 00:00:00 2001 From: "Jiaxiao (mossaka) Zhou" Date: Thu, 16 Jan 2025 18:10:07 +0000 Subject: [PATCH 3/3] content: add community calls and Slack details to both the index and contrib pages Signed-off-by: Jiaxiao (mossaka) Zhou --- content/en/_index.md | 6 ++++++ content/en/docs/contrib/_index.md | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/content/en/_index.md b/content/en/_index.md index c53c492b..3bbe6d47 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -51,4 +51,10 @@ thats aim to ease the experience for scaffolding, deploying and inspecting Spin between Spin and MQTT-based systems, allowing you to automate workflows and trigger actions based on MQTT messages. +### Get Involved + +We have bi-weekly [community calls](https://docs.google.com/document/d/10is2YoNC0NpXw4_5lSyTfpPph9_A9wBissKGrpFaIrI/edit?usp=sharing) and a [Slack channel](https://cloud-native.slack.com/archives/C06PC7JA1EE). We would love to have you join us!
+ +Check out the [contribution guidelines](/docs/contrib/) to learn how to get involved with the project. + {{% /blocks/lead %}} diff --git a/content/en/docs/contrib/_index.md b/content/en/docs/contrib/_index.md index 0d3a98d0..44bad1fd 100644 --- a/content/en/docs/contrib/_index.md +++ b/content/en/docs/contrib/_index.md @@ -8,3 +8,22 @@ aliases: SpinKube is an open source community-driven project. You can contribute in many ways, either to the project or to the wider community. + +## Community Calls + +Join our bi-weekly community calls to connect with the team and other contributors. These calls are a great opportunity to listen in, ask questions, or share your ideas! + +* When: Bi-weekly at 8:00 am PT / 11:00 am ET / 5:00 pm CET + +* Meeting Document: [Community Call Notes](https://docs.google.com/document/d/10is2YoNC0NpXw4_5lSyTfpPph9_A9wBissKGrpFaIrI/edit?usp=sharing) + +* Zoom Link: Join [the Zoom Meeting](https://us06web.zoom.us/j/83473056051?pwd=gDFNQCxUG1OMzdBqTNXIQamlvHjhFo.1) + +## Slack + +Connect with the community on Slack for real-time discussions and updates: + +visit the `#spinkube` channel on the [CNCF +Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE). + +We look forward to seeing you there! \ No newline at end of file