spinkube / documentation

Site and Docs for the SpinKube community project
https://www.spinkube.dev/
Apache License 2.0
15 stars 24 forks source link

Proposal: overhauling the site navigation #189

Closed bacongobbler closed 1 month ago

bacongobbler commented 2 months ago

To me, the site's current navigation seems a little confusing. On one hand, it presents SpinKube as a holistic product for Kubernetes. On the other hand, it presents those topics under a specific sub-project, with most of the content heavily skewed towards the spin-operator project.

As seen here:

spinkube.dev/docs Table of Contents

I would like to propose the following changes to the site:

Move away from spin-operator, more towards Spinkube

A large amount of the content in the spin-operator section describes high level Spinkube topics. Things like:

The topics contained within these sub-sections are not specific to spin-operator.

Move "Concept guides" into a new section called the "Reference guides"

All of these "Concepts" guides are incredibly short, forming only a few sentences at most. For example,

https://www.spinkube.dev/docs/containerd-shim-spin/concepts/ https://www.spinkube.dev/docs/runtime-class-manager/concepts/ https://www.spinkube.dev/docs/spin-plugin-kube/concepts/ https://www.spinkube.dev/docs/spin-trigger-mqtt/

I think it'd be better suited if these were places in a separate section known as the "Reference guides" where we could lay out high-level concepts about Spinkube's architecture, map those concepts back to these projects, and explain those projects in more detail.

How this would look

In my head, the end result would be a table of contents that looks like this:

Thoughts?

vdice commented 2 months ago

👍 I really like the proposed direction @bacongobbler. "Move away from spin-operator, more towards Spinkube" is a great (and timely) guiding principle here. The current layout still represents a time when Spin Operator was the main SpinKube resource but obviously it no longer is. The rough sketch of ToC seems great to me!