feat: support for multi version docs#20
Conversation
Signed-off-by: anish bista <[email protected]>
starbops
left a comment
There was a problem hiding this comment.
Does this mean we'd need to create a new tag in kubevirtbmc/docs? I was hoping we could avoid that release overhead. Instead, I'd prefer the documentation site to serve versioned docs from long-lived branches, with one branch per minor release. That said, if Zensical doesn't make this easy to implement, I'm fine with sticking to the current approach.
Yes, we need to create new tag. But I think long-lived branches approach reduces burden. Let me explore that part and get back here. Thanks |

Docs Versioning Workflow
Day-to-day (no release needed)
Every PR merged to
maintriggers.github/workflows/deploy-docs.yml, which runs:This rebuilds and pushes the
devversion to thegh-pagesbranch, live at docs.kubevirtbmc.io/dev/.✅ This is what unblocks you — merge freely, no release needed.
Cutting a docs release ("stable")
When you want the public/default docs to reflect a new KubeVirtBMC release:
mainhas the docs content you want to snapshot (already merged via normal PRs).v0.9.0, aliases itstable, pushes it togh-pages, and sets it as the default (root/) version.Result:
docs.kubevirtbmc.io/(and/stable/) servesv0.9.0, whiledocs.kubevirtbmc.io/dev/keeps rolling forward with whatever's merged tomainnext. Old version snapshots (v0.8.1, etc.) stay published too —mikenever deletes prior versions unless you runmike delete.GitHub Pages for
kubevirtbmc/docsis presumably configured to deploy via the Actions artifact method (deploy-pages/upload-pages-artifact), which we removed. Sincemikepushes content directly to thegh-pagesbranch instead, someone with admin rights on the repo needs to change:Settings → Pages → Build and deployment → Source → "Deploy from a branch" → branch
gh-pages, folder/(root)Until that's changed, the workflow will push commits to
gh-pagessuccessfully, but GitHub Pages won't serve them.