spinkube / documentation

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

Helm notes are slightly confusing as part of quickstart #144

Open lann opened 3 months ago

lann commented 3 months ago

This is a pretty small papercut but threw me off just enough to lose the flow.

The Quickstart guide has you (among other steps):

Both the Quickstart and the Helm notes make sense on their own, but combined it is confusing what steps are actually required because the RuntimeClass and SpinAppExecutor steps are duplicated but reordered and interleaved. Luckily duplicating these steps is a no-op which is what makes this a "pretty small papercut".

Adding a bit to the confusion about "If you haven't already done so", the kubectl apply URLs between the Quickstart and Helm notes are just different enough to make it unclear whether they are pointing to the same things:

# Quickstart
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml
# Helm notes
kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/spin-runtime-class.yaml
kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/spin-shim-executor.yaml

They currently are the same, though one pointing at a release and the other pointing at main could cause them to go out of sync in the future, especially if someone was trying to install an old Helm chart version.

bacongobbler commented 2 days ago

possibly related to #122