Fix local docs setup (#364)

Author: afritzler

Makefile

@@ -125,7 +125,7 @@ lint-config: golangci-lint ## Verify golangci-lint linter configuration
 .PHONY: startdocs
 startdocs: ## Start the local mkdocs based development environment.
 	docker build -t $(IMAGE) -f docs/Dockerfile . --load
-	docker run -p 5173:5173 -v `pwd`/:/app $(IMAGE)
+	docker run --rm -p 5173:5173 -v `pwd`/:/app $(IMAGE)
 
 .PHONY: cleandocs
 cleandocs: ## Remove all local mkdocs Docker images (cleanup).

docs/Dockerfile

@@ -6,12 +6,8 @@ RUN apk add --no-cache bash
 # Set working directory
 WORKDIR /app
 
-# Install vitepress globally (optional, npx will work too)
-RUN npm install -g vitepress
-RUN npm install -g vitepress-plugin-mermaid
-
 # Expose dev port
 EXPOSE 5173
 
 # Default command to start VitePress dev
-CMD ["npx", "vitepress", "dev", "docs", "--host", "0.0.0.0"]
+ENTRYPOINT ["./hack/start-docs.sh"]

docs/index.md

@@ -4,8 +4,8 @@ layout: home
 
 hero:
   name: "Metal Operator"
-  text: "Kubernetes operator to automate bare metal servers"
-  tagline: "Automate your bare metal servers with Kubernetes native API"
+  text: "Kubernetes operator to automate Bare Metal Servers"
+  tagline: "Automate your Bare Metal Servers with Kubernetes native API"
   image:
     src: https://raw.githubusercontent.com/ironcore-dev/ironcore/refs/heads/main/docs/assets/logo_borderless.svg
     alt: VitePress

hack/start-docs.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# Install dependencies
+npm ci
+
+# Run VitePress dev server
+npx vitepress dev docs --host 0.0.0.0 &
+
+# Store the PID of the VitePress process
+VITEPRESS_PID=$!
+
+# Function to handle SIGINT (Ctrl+C)
+handle_sigint() {
+    echo "Stopping VitePress dev server..."
+    kill -TERM "$VITEPRESS_PID"
+    wait "$VITEPRESS_PID"
+    exit 0
+}
+
+# Trap SIGINT and call the handle_sigint function
+trap handle_sigint SIGINT
+
+# Wait for the VitePress process to finish
+wait "$VITEPRESS_PID"