Merge pull request #959 from cakephp/5.x-docs

adjustments to make 3.x docs deploy work

Author: LordSimal

.github/workflows/deploy_docs_5x.yml

@@ -0,0 +1,24 @@
+---
+name: 'deploy_docs_5x'
+
+on:
+  push:
+    branches:
+      - 5.x
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cloning repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Push to dokku
+        uses: dokku/github-action@master
+        with:
+          git_remote_url: 'ssh://[email protected]:22/debugkit-docs-5'
+          git_push_flags: '-f'
+          ssh_private_key: ${{ secrets.DOKKU_SSH_PRIVATE_KEY }}

Dockerfile

@@ -1,7 +1,7 @@
 # Basic docker based environment
 # Necessary to trick dokku into building the documentation
 # using dockerfile instead of herokuish
-FROM ubuntu:17.04
+FROM ubuntu:22.04
 
 # Add basic tools
 RUN apt-get update && \
@@ -13,9 +13,11 @@ RUN apt-get update && \
     libffi-dev \
     libssl-dev
 
+# Prevent interactive timezone input
+ENV DEBIAN_FRONTEND=noninteractive
 RUN LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php && \
   apt-get update && \
-  apt-get install -y php7.2-cli php7.2-mbstring php7.2-xml php7.2-zip php7.2-intl php7.2-opcache php7.2-sqlite
+  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
 
 WORKDIR /code
 

README.md

@@ -38,7 +38,7 @@ $this->addPlugin('DebugKit');
 
 If you don't see a CakePHP icon on the bottom right of your page DebugKit is not be
 working correctly. Some common problems are:
- 
+
 1. Your PHP environment doesn't have SQLite installed. Check your application
    logs to confirm if this happening. You can either configure DebugKit to use
    a different database, or install the PDO SQLite 3 extension.
@@ -61,5 +61,5 @@ requests](https://help.github.com/articles/using-pull-requests) or open
 
 ## Documentation
 
-Documentation for DebugKit can be found in the 
-[CakePHP documentation](https://book.cakephp.org/debugkit/4/en/index.html).
+Documentation for DebugKit can be found in the
+[CakePHP documentation](https://book.cakephp.org/debugkit/5/en/index.html).

docs.Dockerfile

@@ -20,7 +20,7 @@ FROM ghcr.io/cakephp/docs-builder:runtime as runtime
 # Configure search index script
 ENV LANGS="en fr ja pt"
 ENV SEARCH_SOURCE="/usr/share/nginx/html"
-ENV SEARCH_URL_PREFIX="/debugkit/4"
+ENV SEARCH_URL_PREFIX="/debugkit/5"
 
 COPY --from=builder /data/docs /data/docs
 COPY --from=builder /data/website /data/website

docs/config/all.py

@@ -10,10 +10,10 @@
 #
 
 # The full version, including alpha/beta/rc tags.
-release = '4.x'
+release = '5.x'
 
 # The search index version.
-search_version = 'debugkit-4'
+search_version = 'debugkit-5'
 
 # The marketing display name for the book.
 version_name = ''
@@ -24,18 +24,19 @@
 # Other versions that display in the version picker menu.
 version_list = [
     {'name': '3.x', 'number': 'debugkit/3.x', 'title': '3.x'},
-    {'name': '4.x', 'number': 'debugkit/4.x', 'title': '4.x', 'current': True},
+    {'name': '4.x', 'number': 'debugkit/4.x', 'title': '4.x'},
+    {'name': '5.x', 'number': 'debugkit/5.x', 'title': '5.x', 'current': True},
 ]
 
 # Languages available.
 languages = ['en', 'fr', 'ja', 'pt']
 
 # The GitHub branch name for this version of the docs
 # for edit links to point at.
-branch = '4.x'
+branch = '5.x'
 
 # Current version being built
-version = '4.x'
+version = '5.x'
 
 # Language in use for this directory.
 language = 'en'