Upgrade Hugo to v0.152.2 and migrate to Docsy Go module (#714)

Signed-off-by: Kay Yan <[email protected]>

Author: yankay

Makefile

@@ -326,6 +326,10 @@ code-generator:
 	cp -f $(CODEGEN_ROOT)/generate-internal-groups.sh $(PROJECT_DIR)/bin/
 	cp -f $(CODEGEN_ROOT)/kube_codegen.sh $(PROJECT_DIR)/bin/
 
+.PHONY: site-server
+site-server: hugo
+	(cd site; $(HUGO) server)
+
 ##@ Release
 .PHONY: artifacts
 artifacts: kustomize helm yq
@@ -345,7 +349,7 @@ artifacts: kustomize helm yq
 
 .PHONY: prepare-release-branch
 prepare-release-branch: yq kustomize ## Prepare the release branch with the release version.
-	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/config.toml
+	$(SED) -r 's/v[0-9]+\.[0-9]+\.[0-9]+/$(RELEASE_VERSION)/g' -i README.md -i site/hugo.toml
 	$(SED) -r 's/--version="v?[0-9]+\.[0-9]+\.[0-9]+/--version="$(CHART_VERSION)/g' -i charts/lws/README.md
 	$(SED) -r 's/\bVERSION=(\s*)v?[0-9]+\.[0-9]+\.[0-9]+\b/VERSION=\1$(RELEASE_VERSION)/g' -i site/content/en/docs/installation/_index.md
 	$(SED) -r 's/\bCHART_VERSION=(\s*)v?[0-9]+\.[0-9]+\.[0-9]+\b/CHART_VERSION=\1$(CHART_VERSION)/g' -i site/content/en/docs/installation/_index.md
@@ -378,6 +382,12 @@ YQ = $(PROJECT_DIR)/bin/yq
 yq: ## Download yq locally if necessary.
 	GOBIN=$(PROJECT_DIR)/bin GO111MODULE=on $(GO_CMD) install github.com/mikefarah/yq/[email protected]
 
+
+HUGO = $(PROJECT_DIR)/bin/hugo
+.PHONY: hugo
+hugo:
+	@GOBIN=$(PROJECT_DIR)/bin CGO_ENABLED=1 $(GO_CMD) install -tags extended github.com/gohugoio/[email protected]
+
 .PHONY: crds
 crds: kustomize yq # update helm CRD files
 	$(KUSTOMIZE) build config/default \

netlify.toml

@@ -4,11 +4,11 @@
   command = "npm install && hugo --gc --minify"
 
 [context.deploy-preview.environment]
-  HUGO_VERSION = "0.92.0"
+  HUGO_VERSION = "0.152.2"
 
 [context.production.environment]
-  HUGO_VERSION = "0.92.0"
+  HUGO_VERSION = "0.152.2"
   HUGO_ENV = "production"
 
 [context.branch-deploy.environment]
-  HUGO_VERSION = "0.92.0"
+  HUGO_VERSION = "0.152.2"

site/content/en/docs/examples/vllm.md

@@ -16,7 +16,7 @@ We use LeaderWorkerSet to deploy two vLLM model replicas. We have two flavors of
 
 In both examples, Ray uses the leader pod as the head node and the worker pods as the worker nodes. The leader pod runs the vLLM server, with a ClusterIP Service exposing the port.
 
-{{< tabpane >}}
+{{< tabpane persist=false >}}
 {{< tab header="GPU" lang="shell" >}}
 export HF_TOKEN=<your-hf-token>
 curl https://raw.githubusercontent.com/kubernetes-sigs/lws/refs/heads/main/docs/examples/vllm/GPU/lws.yaml -s | envsubst | kubectl apply -f -

site/go.mod

@@ -0,0 +1,5 @@
+module sigs.k8s.io/lws/site
+
+go 1.25.0
+
+require github.com/google/docsy v0.13.0 // indirect

site/go.sum

@@ -0,0 +1,4 @@
+github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
+github.com/google/docsy v0.13.0 h1:Y1oy5SmQ0ikJJsvkuefEVZMj0MTXLmVfpXbt7Ytc7rc=
+github.com/google/docsy v0.13.0/go.mod h1:1Fj1W1O3esZh7IBQ8XAYtxtg10udBXuGI89+LUQc1AU=
+github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

site/config.toml renamed to site/hugo.toml

@@ -3,9 +3,6 @@ title = "LWS"
 
 enableRobotsTXT = true
 
-theme = "docsy"
-themesDir = "node_modules"
-
 ###############################################################################
 # Docsy
 ###############################################################################
@@ -19,7 +16,7 @@ defaultContentLanguageInSubdir = false
 # useful when translating
 enableMissingTranslationPlaceholders = true
 # disable taxonomies
-disableKinds = ["taxonomy", "taxonomyTerm"]
+disableKinds = ["taxonomy"]
 # deprecated directories
 ignoreFiles = []
 ###############################################################################
@@ -158,4 +155,12 @@ ignoreFiles = []
     name = "Slack"
     url = "https://kubernetes.slack.com/"
     icon = "fab fa-slack"
-    desc = "Chat with other project developers"
+    desc = "Chat with other project developers"
+
+[module]
+  proxy = "direct"
+  [module.hugoVersion]
+    extended = true
+  [[module.imports]]
+    path = "github.com/google/docsy"
+    disable = false

site/layouts/partials/feedback.html

@@ -20,10 +20,10 @@ <h3 class="card-title">Feedback</h3>
       <button class="btn btn-primary feedback--answer feedback--answer-yes" style="width: 5rem;">Yes</button>
       <button class="btn btn-primary feedback--answer feedback--answer-no" style="width: 5rem;">No</button>
       <p class="feedback--response feedback--response-yes">
-        {{ .yes | safeHTML }}
+        {{ .Site.Params.ui.feedback.yes | safeHTML }}
       </p>
       <p class="feedback--response feedback--response-no">
-        {{ .no | safeHTML }}
+        {{ .Site.Params.ui.feedback.no | safeHTML }}
       </p>
     </div>
   </div>

site/layouts/partials/head.html

@@ -48,9 +48,5 @@
 
 {{/* To comply with GDPR, cookie consent scripts places in head-end must execute before Google Analytics is enabled */ -}}
 {{ if hugo.IsProduction -}}
-  {{ if hasPrefix .Site.GoogleAnalytics "G-" -}}
-    {{ template "_internal/google_analytics.html" . -}}
-  {{ else -}}
-    {{ template "_internal/google_analytics_async.html" . -}}
-  {{ end -}}
-{{ end -}}
+  {{ template "_internal/google_analytics.html" . -}}
+{{ end -}}