Documentation
¶
Overview ¶
Command docsversions builds every published version of a versioned Hugo documentation site with ONE look, and puts the builds in a GitLab package registry:
docsversions build --url https://example.org/docs --out versions docsversions publish --dir versions --package example-docs --archive example-docs.tar.gz
A version of the documentation is its CONTENT. Everything else -- the theme submodule, hugo.yaml, layouts, CSS, i18n, static files, the logos -- is the site's look, and it comes from the DEFAULT BRANCH for every version: `build` checks the default branch out once (a detached worktree, submodules included), then for each version replaces its content directory with the one the version's ref holds, and runs Hugo with that version's baseURL. Versions are "development" (the default branch) and every strict semantic version tag vX.Y.Z.
⛔ It exists because the look was frozen into each release. GT-Cloud's /docs/ served v1.0.3, built from a release branch that predated the logo menu, the language icon and the theme combo: three patch releases made only to carry a favicon, a logo and a colour to the default page each re-published the OLD interface around them, and the user saw a RESINFO link in the wrong place. "The look should not depend on the version."
Source Files