Skip to content

Commit

Permalink
docs: Give categories weight for better IA
Browse files Browse the repository at this point in the history
The docs navigation is currently jumbled, without a consistent
order for documentation. This PR gives weight to the content -
the highest for the Overview, so it sticks to the top, then a descending
order for the spin-operator, shim, class-manager, and spin-plugin based
partially on the order that we expect folks to discover them in.

Signed-off-by: Danielle Lancashire <dani@builds.terrible.systems>
  • Loading branch information
endocrimes committed Mar 8, 2024
1 parent 58c6321 commit 12a435c
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions content/en/docs/containerd-shim-spin/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: containerd-shim-spin
description: The Containerd Shim Spin is a project that integrates WebAssembly (Wasm) and WASI workloads into Kubernetes.
categories: [Containerd Shim Spin]
tags: [containerd-shim-spin]
weight: 100
weight: 60
---

The [Containerd Shim Spin repository](https://github.com/spinkube/containerd-shim-spin), or "contained-shim-spin," provides shim implementations for running WebAssembly ([Wasm](https://webassembly.org/)) / Wasm System Interface ([WASI](https://github.com/WebAssembly/WASI)) workloads using [runwasi](https://github.com/deislabs/runwasi) as a library, whereby workloads built using the [Spin framework](https://github.com/fermyon/spin) can function similarly to container workloads in a Kubernetes environment.
Expand All @@ -12,4 +12,4 @@ The containerd-shim-spin is specifically designed to work with the [Spin](https:

In a Kubernetes cluster, specific nodes can be bootstrapped with Wasm runtimes and labeled accordingly to facilitate the scheduling of Wasm workloads. RuntimeClasses in Kubernetes are used to schedule Pods to specific nodes and target specific runtimes. By defining a RuntimeClass with the appropriate nodeSelector and handler, Kubernetes can direct Wasm workloads to nodes equipped with the necessary Wasm runtimes and ensure they are executed with the correct runtime handler.

Overall, the Containerd Shim Spin represents a significant advancement in integrating Wasm workloads into Kubernetes clusters, enhancing the versatility and capabilities of container orchestration.
Overall, the Containerd Shim Spin represents a significant advancement in integrating Wasm workloads into Kubernetes clusters, enhancing the versatility and capabilities of container orchestration.
2 changes: 1 addition & 1 deletion content/en/docs/overview/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Overview
description: A high level overview of the SpinKube sub-projects
weight: 100
weight: 1
categories: [SpinKube]
tags: [Overview]
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/runtime-class-manager/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: runtime-class-manager
description: Enhance Kubernetes with Runtime-Class-Manager; efficient Containerd shim handling.
categories: [Runtime Class Manager]
tags: [runtime-class-manager]
weight: 100
weight: 70
---

The [Runtime Class Manager, also known as the Containerd Shim Lifecycle Operator](https://github.com/spinkube/runtime-class-manager), is designed to automate and manage the lifecycle of containerd shims in a Kubernetes environment. This includes tasks like installation, update, removal, and configuration of shims, reducing manual errors and improving reliability in managing WebAssembly (Wasm) workloads and other containerd extensions.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/spin-operator/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Spin Operator
title: spin-operator
description: Spin Operator
categories: [Spin Operator]
tags: [Spin Operator]
weight: 100
weight: 50
---

### What Is Spin Operator?
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/spin-plugin-kube/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: spin-plugin-kube
description: Enhance Kubernetes by enabling the execution of Wasm modules directly within a Kubernetes cluster
categories: []
tags: []
weight: 100
weight: 80
---

The [Kubernetes plugin for Spin](https://github.com/spinkube/spin-plugin-kube) is designed to enhance Spin by enabling the execution of Wasm modules directly within a Kubernetes cluster. Specifically a tool designed for Kubernetes integration with the Spin command-line interface. This plugin works by integrating with containerd shims, allowing Kubernetes to manage and run Wasm workloads in a way similar to traditional container workloads.
Expand Down

0 comments on commit 12a435c

Please sign in to comment.