We've gotten feedback that the quickstart documentation with the baked in containerd-shim-spin binary is a confusing starting point because it makes it hard to understand how to update your shim or add it to an existing cluster.
Our installation docs consist of the following:
- a quickstart to quickly get going by using a k3d cluster that has the shim embedded
- specialized installation guides for distros that may have different set ups
- "Installing with Helm" guide which is the installation guide IMO. It can be used to install the shim on any distro
I think we should reorganize the docs to make this clearer, maybe by having the installing with helm guide be the installation guide and then another tab for other specialized installs. Then we can have a small callout somewhere in the guide that says "for dev scenarios, you can skip using RCM and use this k3d image pre-shipped with the shim".
We've gotten feedback that the quickstart documentation with the baked in containerd-shim-spin binary is a confusing starting point because it makes it hard to understand how to update your shim or add it to an existing cluster.
Our installation docs consist of the following:
I think we should reorganize the docs to make this clearer, maybe by having the installing with helm guide be the installation guide and then another tab for other specialized installs. Then we can have a small callout somewhere in the guide that says "for dev scenarios, you can skip using RCM and use this k3d image pre-shipped with the shim".