Introduce VitePress documentation using @cakephp/docs-skeleton

.github/workflows/ci.yml

@@ -7,9 +7,13 @@ on:
       - 4.x
       - 4.next
       - 5.x
+    paths-ignore:
+      - docs/**
   pull_request:
     branches:
       - '*'
+    paths-ignore:
+      - docs/**
   workflow_dispatch:
 
 permissions:

Dockerfile

@@ -1,25 +1,36 @@
-# Basic docker based environment
-# Necessary to trick dokku into building the documentation
-# using dockerfile instead of herokuish
-FROM ubuntu:22.04
-
-# Add basic tools
-RUN apt-get update && \
-  apt-get install -y build-essential \
-    software-properties-common \
-    curl \
-    git \
-    libxml2 \
-    libffi-dev \
-    libssl-dev && \
-  LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php && \
-  apt-get update && \
-  apt-get install -y php8.1-cli php8.1-mbstring php8.1-xml php8.1-zip php8.1-intl php8.1-opcache php8.1-sqlite &&\
-  apt-get clean &&\
-  rm -rf /var/lib/apt/lists/*
-
-WORKDIR /code
-
-VOLUME ["/code"]
-
-CMD [ '/bin/bash' ]
+# ----------------------
+# 1. Build stage
+# ----------------------
+FROM node:22-alpine AS builder
+
+# Git is required because docs/package.json pulls a dependency from GitHub.
+RUN apk add --no-cache git openssh-client
+
+WORKDIR /app/docs
+
+# Copy dependency manifests first to preserve Docker layer caching.
+COPY docs/ ./
+RUN npm ci
+
+# Increase max-old-space-size to avoid memory issues during build
+ENV NODE_OPTIONS="--max-old-space-size=8192"
+
+# Build the site.
+RUN npm run docs:build
+
+# ----------------------
+# 2. Runtime stage (nginx)
+# ----------------------
+FROM nginx:1.27-alpine AS runner
+
+# Copy built files
+COPY --from=builder /app/docs/.vitepress/dist /usr/share/nginx/html
+
+# Expose port
+EXPOSE 80
+
+# Health check (optional)
+HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:80/ || exit 1
+
+# Start nginx
+CMD ["nginx", "-g", "daemon off;"]

docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*/public/
+.vitepress/cache

docs/.vitepress/config.js

@@ -0,0 +1,51 @@
+import baseConfig from '@cakephp/docs-skeleton/config'
+
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const toc_en = require("./toc_en.json");
+
+const versions = {
+  text: "5.x",
+  items: [
+    { text: "5.x (current)", link: "book.cakephp.org/migrations/5.x/", target: '_self' },
+    { text: "4.x", link: "https://book.cakephp.org/migrations/4/", target: '_self' },
+    { text: "3.x", link: "https://book.cakephp.org/migrations/3/", target: '_self' },
+    { text: "2.x", link: "https://book.cakephp.org/migrations/2/", target: '_self' },
+  ],
+};
+
+// This file contains overrides for .vitepress/config.js
+export default {
+  extends: baseConfig,
+  srcDir: 'en',
+  title: 'Migrations plugin',
+  description: 'Migrations - CakePHP migrations Documentation',
+  base: "/5.x/",
+  rewrites: {
+    "en/:slug*": ":slug*",
+  },
+  sitemap: {
+    hostname: "https://book.cakephp.org/migrations/5.x/",
+  },
+  themeConfig: {
+    socialLinks: [
+      { icon: "github", link: "https://github.com/cakephp/cakephp" },
+    ],
+    editLink: {
+      pattern: "https://github.com/cakephp/migrations/edit/5.x/docs/:path",
+      text: "Edit this page on GitHub",
+    },
+    sidebar: toc_en,
+    nav: [
+      { text: "CakePHP Book", link: "https://book.cakephp.org/" },
+      { ...versions },
+    ],
+  },
+  substitutions: {},
+  locales: {
+    root: {
+      label: "English",
+      lang: "en",
+    },
+  },
+};

docs/.vitepress/theme/index.js

@@ -0,0 +1 @@
+export { default } from '@cakephp/docs-skeleton'

docs/.vitepress/toc_en.json

@@ -0,0 +1,23 @@
+{
+  "/": [
+    {
+      "text": "Migrations",
+      "collapsed": false,
+      "items": [
+        { "text": "Introduction", "link": "/index" },
+        { "text": "Writing Migrations", "link": "/writing-migrations" },
+        { "text": "Using the Query Builder", "link": "/using-the-query-builder" },
+        { "text": "Executing Queries", "link": "/executing-queries" },
+        { "text": "Database Seeding", "link": "/seeding" }
+      ]
+    },
+    {
+      "text": "Upgrade Guides",
+      "collapsed": true,
+      "items": [
+        { "text": "Upgrading from 4.x to 5.x", "link": "/upgrading" },
+        { "text": "Upgrading to the Builtin Backend", "link": "/upgrading-to-builtin-backend" }
+      ]
+    }
+  ]
+}

docs/en/contents.md

@@ -0,0 +1,8 @@
+### CakePHP Migrations
+
+- [Migrations 5.x](index)
+- [Writing Migrations](writing-migrations)
+- [Using the Query Builder](using-the-query-builder)
+- [Executing Queries](executing-queries)
+- [Database Seeding](seeding)
+- [Upgrading to the builtin backend](upgrading-to-builtin-backend)