@bluedynamics/cdk8s-plone 0.1.4 → 0.1.6

package/README.md

@@ -1,56 +1,38 @@
 # CDK8S Plone
 
-A CDK8S library for deploying Plone CMS to Kubernetes.
+> TypeScript and Python library for deploying Plone CMS to Kubernetes using CDK8S
 
-This library provides constructs to bootstrap a Plone deployment on a Kubernetes cluster using the [CDK8S](https://cdk8s.io) framework.
+[![npm version](https://badge.fury.io/js/%40bluedynamics%2Fcdk8s-plone.svg)](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone)
+[![PyPI version](https://badge.fury.io/py/cdk8s-plone.svg)](https://pypi.org/project/cdk8s-plone/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 
-## Features
+## Overview
 
-- **Backend**: Plone backend (API with `plone.volto` or Classic-UI)
-- **Frontend**: Plone Volto (modern React-based user interface)
-- **Varnish Caching**: Optional HTTP caching layer using [kube-httpcache](https://github.com/mittwald/kube-httpcache) with cluster-wide cache invalidation
-- **High Availability**: Configurable replicas with PodDisruptionBudgets
-- **Multi-language Support**: Published to npm (TypeScript/JavaScript) and PyPI (Python)
+cdk8s-plone provides CDK8S constructs for deploying [Plone CMS](https://plone.org/) on Kubernetes. Define your infrastructure using TypeScript or Python and generate Kubernetes manifests automatically.
 
+**Key Features:**
+- 🚀 Supports Volto (modern React frontend) and Classic UI
+- 📦 High availability with configurable replicas
+- ⚡ Optional Varnish HTTP caching layer
+- 🔧 Fine-grained resource and probe configuration
+- 🌍 Multi-language support (TypeScript/JavaScript and Python)
+- ✅ Type-safe infrastructure as code
 
-## Installation
-
-### TypeScript/JavaScript
-
-Create a new CDK8S project (or use an existing one):
-
-```bash
-cdk8s init typescript-app
-```
+## Quick Start
 
-Install the library:
+### Installation
 
+**TypeScript/JavaScript:**
 ```bash
 npm install @bluedynamics/cdk8s-plone
 ```
 
-Package: [@bluedynamics/cdk8s-plone](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone)
-
-### Python
-
-Create a new CDK8S project:
-
-```bash
-cdk8s init python-app
-```
-
-Install the library:
-
+**Python:**
 ```bash
 pip install cdk8s-plone
 ```
 
-Package: [cdk8s-plone](https://pypi.org/project/cdk8s-plone/)
-
-
-## Quick Start
-
-### Basic Plone Deployment
+### Basic Example
 
 ```typescript
 import { App, Chart } from 'cdk8s';
@@ -62,7 +44,7 @@ const chart = new Chart(app, 'PloneDeployment');
 new Plone(chart, 'my-plone', {
   variant: PloneVariant.VOLTO,
   backend: {
-    image: 'plone/plone-backend:6.0.10',
+    image: 'plone/plone-backend:6.1.3',
     replicas: 3,
   },
   frontend: {
@@ -74,173 +56,68 @@ new Plone(chart, 'my-plone', {
 app.synth();
 ```
 
-### With Varnish HTTP Cache
-
-```typescript
-import { PloneHttpcache } from '@bluedynamics/cdk8s-plone';
-
-const plone = new Plone(chart, 'my-plone', {
-  variant: PloneVariant.VOLTO,
-  backend: { image: 'plone/plone-backend:6.0.10' },
-  frontend: { image: 'plone/plone-frontend:16.0.0' },
-});
-
-new PloneHttpcache(chart, 'cache', {
-  plone: plone,
-  existingSecret: 'varnish-secret',
-  replicas: 2,
-});
-```
-
-### Generate Kubernetes Manifests
-
+Generate Kubernetes manifests:
 ```bash
 cdk8s synth
+kubectl apply -f dist/
 ```
 
-The manifests are stored in the `dist/` directory.
-
-For a complete example, see the [example project](https://github.com/bluedynamics/cdk8s-plone-example).
-
-## Prerequisites
-
-- **kubectl** - Command-line tool for deploying Kubernetes manifests. [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
-- **Helm** (optional) - Only needed if generating Helm charts. [Install Helm](https://helm.sh/docs/intro/install/)
-- **Node.js** - For TypeScript/JavaScript development
-- **Python 3.8+** - For Python development
+## Documentation
 
+**📚 Full documentation:** https://bluedynamics.github.io/cdk8s-plone/
 
-## API Documentation
+- [Quick Start Tutorial](https://bluedynamics.github.io/cdk8s-plone/tutorials/01-quick-start.html)
+- [Configuration Reference](https://bluedynamics.github.io/cdk8s-plone/reference/configuration-options.html)
+- [Architecture Overview](https://bluedynamics.github.io/cdk8s-plone/explanation/architecture.html)
+- [Complete API Documentation](./API.md)
 
-For complete API documentation, see [API.md](./API.md).
+## Examples
 
-### Key Constructs
+See the [cdk8s-plone-example](https://github.com/bluedynamics/cdk8s-plone-example) repository for complete working examples.
 
-#### `Plone`
+## Requirements
 
-Main construct for deploying Plone CMS. Supports two variants:
-- **VOLTO**: Modern React frontend with REST API backend (default)
-- **CLASSICUI**: Traditional server-side rendered Plone
-
-Properties:
-- `backendServiceName` - Name of the backend Kubernetes service
-- `frontendServiceName` - Name of the frontend service (VOLTO only)
-- `variant` - Deployment variant (VOLTO or CLASSICUI)
-- `siteId` - Plone site ID in ZODB (default: 'Plone')
-
-#### `PloneHttpcache`
-
-Varnish HTTP caching layer using the [kube-httpcache](https://github.com/mittwald/kube-httpcache) Helm chart.
-
-Properties:
-- `httpcacheServiceName` - Name of the Varnish service
-
-### Configuration Options
-
-#### `PloneOptions`
-
-- `version` - Version of your project
-- `siteId` - Plone site ID (default: 'Plone')
-- `variant` - PloneVariant.VOLTO or PloneVariant.CLASSICUI (default: VOLTO)
-- `backend` - Backend configuration (PloneBaseOptions)
-- `frontend` - Frontend configuration (PloneBaseOptions, required for VOLTO)
-- `imagePullSecrets` - Image pull secrets for private registries
-
-#### `PloneBaseOptions`
-
-Configuration for backend or frontend:
-
-**Container:**
-- `image` - Container image (e.g., 'plone/plone-backend:6.0.10')
-- `imagePullPolicy` - Pull policy (default: 'IfNotPresent')
-- `replicas` - Number of replicas (default: 2)
-- `environment` - Environment variables (cdk8s-plus-30.Env)
-
-**Resources:**
-- `requestCpu` / `limitCpu` - CPU requests/limits
-- `requestMemory` / `limitMemory` - Memory requests/limits
-
-**High Availability:**
-- `minAvailable` - Min pods during updates (for PodDisruptionBudget)
-- `maxUnavailable` - Max unavailable pods during updates
-
-**Health Probes:**
-- `readinessEnabled` - Enable readiness probe (default: true)
-- `readinessInitialDelaySeconds` / `readinessTimeoutSeconds` / `readinessPeriodSeconds`
-- `readinessSuccessThreshold` / `readinessFailureThreshold`
-- `livenessEnabled` - Enable liveness probe (default: false, recommended true for frontend)
-- `livenessInitialDelaySeconds` / `livenessTimeoutSeconds` / `livenessPeriodSeconds`
-- `livenessSuccessThreshold` / `livenessFailureThreshold`
-
-**Annotations:**
-- `annotations` - Deployment metadata annotations
-- `podAnnotations` - Pod template annotations (e.g., for Prometheus)
-- `serviceAnnotations` - Service annotations (e.g., for external-dns)
-
-#### `PloneHttpcacheOptions`
-
-- `plone` - Plone construct to attach cache to (required)
-- `varnishVcl` - VCL configuration as string
-- `varnishVclFile` - Path to VCL configuration file
-- `existingSecret` - Kubernetes secret for Varnish admin credentials
-- `replicas` - Number of Varnish replicas (default: 2)
-- `requestCpu` / `limitCpu` - CPU resources
-- `requestMemory` / `limitMemory` - Memory resources
-- `servicemonitor` - Enable Prometheus ServiceMonitor (default: false)
-- `exporterEnabled` - Enable Prometheus exporter sidecar (default: true)
-- `chartVersion` - kube-httpcache Helm chart version (default: latest)
+- **kubectl** - [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
+- **Node.js 16+** (for TypeScript/JavaScript) - [Install Node.js](https://nodejs.org/)
+- **Python 3.8+** (for Python) - [Install Python](https://www.python.org/)
+- **Kubernetes cluster** (local or cloud)
 
+For detailed setup instructions, see [Setup Prerequisites](https://bluedynamics.github.io/cdk8s-plone/how-to/setup-prerequisites.html).
 
 ## Development
 
-This project uses [Projen](https://projen.io/) to manage project configuration. **Do not edit generated files directly.**
-
-### Setup
-
-Clone the repository and install dependencies:
+This project uses [Projen](https://projen.io/) for project management.
 
 ```bash
-nvm use lts/*
-corepack enable
-npx projen
-```
-
-### Common Commands
+# Install dependencies
+npm install
 
-```bash
 # Run tests
-npx projen test
-
-# Run tests in watch mode
-npx projen test:watch
+npm test
 
-# Build (compile TypeScript + generate JSII bindings)
-npx projen build
+# Build
+npm run build
 
-# Lint
-npx projen eslint
-
-# Generate API documentation
-npx projen docgen
-
-# Package for distribution
-npx projen package-all
+# Update project configuration
+# Edit .projenrc.ts, then run:
+npx projen
 ```
 
-### Making Changes
-
-1. Edit `.projenrc.ts` for project configuration changes
-2. Run `npx projen` to regenerate project files
-3. Make code changes in `src/`
-4. Run tests and update snapshots if needed: `npx projen test -- -u`
+For detailed development instructions, see [CONTRIBUTING.md](./CONTRIBUTING.md) (if available).
 
-## References
+## Resources
 
 - [CDK8S Documentation](https://cdk8s.io/)
-- [Kubernetes Probes Documentation](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/)
-- [kube-httpcache Helm Chart](https://github.com/mittwald/kube-httpcache)
+- [Plone CMS](https://plone.org/)
+- [kube-httpcache](https://github.com/mittwald/kube-httpcache) (for HTTP caching)
 - [Example Project](https://github.com/bluedynamics/cdk8s-plone-example)
 
 ## License
 
-See [LICENSE](./LICENSE) file.
+[Apache 2.0](LICENSE)
+
+## Maintainers
+
+Maintained by [Blue Dynamics Alliance](https://github.com/bluedynamics)
+
+**Author:** Jens W. Klein (jk@kleinundpartner.at)

package/documentation/Makefile

@@ -0,0 +1,357 @@
+##############################################################################
+# THIS FILE IS GENERATED BY MXMAKE
+#
+# DOMAINS:
+#: core.base
+#: core.mxenv
+#: docs.sphinx
+#
+# SETTINGS (ALL CHANGES MADE BELOW SETTINGS WILL BE LOST)
+##############################################################################
+
+## core.base
+
+# `deploy` target dependencies.
+# No default value.
+DEPLOY_TARGETS?=
+
+# target to be executed when calling `make run`
+# No default value.
+RUN_TARGET?=
+
+# Additional files and folders to remove when running clean target
+# No default value.
+CLEAN_FS?=
+
+# Optional makefile to include before default targets. This can
+# be used to provide custom targets or hook up to existing targets.
+# Default: include.mk
+INCLUDE_MAKEFILE?=include.mk
+
+# Optional additional directories to be added to PATH in format
+# `/path/to/dir/:/path/to/other/dir`. Gets inserted first, thus gets searched
+# first.
+# No default value.
+EXTRA_PATH?=
+
+# Path to Python project relative to Makefile (repository root).
+# Leave empty if Python project is in the same directory as Makefile.
+# For monorepo setups, set to subdirectory name (e.g., `backend`).
+# Future-proofed for multi-language monorepos (e.g., PROJECT_PATH_NODEJS).
+# No default value.
+PROJECT_PATH_PYTHON?=
+
+## core.mxenv
+
+# Primary Python interpreter to use. It is used to create the
+# virtual environment if `VENV_ENABLED` and `VENV_CREATE` are set to `true`.
+# If global `uv` is used, this value is passed as `--python VALUE` to the venv creation.
+# uv then downloads the Python interpreter if it is not available.
+# for more on this feature read the [uv python documentation](https://docs.astral.sh/uv/concepts/python-versions/)
+# Default: python3
+PRIMARY_PYTHON?=3.13
+
+# Minimum required Python version.
+# Default: 3.10
+PYTHON_MIN_VERSION?=3.13
+
+# Install packages using the given package installer method.
+# Supported are `pip` and `uv`. When `uv` is selected, a global installation
+# is auto-detected and used if available. Otherwise, uv is installed in the
+# virtual environment or using `PRIMARY_PYTHON`, depending on the
+# `VENV_ENABLED` setting.
+# Default: pip
+PYTHON_PACKAGE_INSTALLER?=uv
+
+# Python version for UV to install/use when creating virtual
+# environments with global UV. Passed to `uv venv -p VALUE`. Supports version
+# specs like `3.11`, `3.14`, `cpython@3.14`. Defaults to PRIMARY_PYTHON value
+# for backward compatibility.
+# Default: $(PRIMARY_PYTHON)
+UV_PYTHON?=$(PRIMARY_PYTHON)
+
+# Flag whether to use virtual environment. If `false`, the
+# interpreter according to `PRIMARY_PYTHON` found in `PATH` is used.
+# Default: true
+VENV_ENABLED?=true
+
+# Flag whether to create a virtual environment. If set to `false`
+# and `VENV_ENABLED` is `true`, `VENV_FOLDER` is expected to point to an
+# existing virtual environment.
+# Default: true
+VENV_CREATE?=true
+
+# The folder of the virtual environment.
+# If `VENV_ENABLED` is `true` and `VENV_CREATE` is true it is used as the
+# target folder for the virtual environment. If `VENV_ENABLED` is `true` and
+# `VENV_CREATE` is false it is expected to point to an existing virtual
+# environment. If `VENV_ENABLED` is `false` it is ignored.
+# Default: .venv
+VENV_FOLDER?=.venv
+
+# mxdev to install in virtual environment.
+# Default: mxdev
+MXDEV?=mxdev
+
+# mxmake to install in virtual environment.
+# Default: mxmake
+MXMAKE?=mxmake
+
+## docs.sphinx
+
+# Documentation source folder.
+# Default: docs/source
+DOCS_SOURCE_FOLDER?=sources
+
+# Documentation generation target folder.
+# Default: docs/html
+DOCS_TARGET_FOLDER?=html
+
+# Documentation linkcheck output folder.
+# Default: docs/linkcheck
+DOCS_LINKCHECK_FOLDER?=docs/linkcheck
+
+# Documentation Python requirements to be installed (via pip).
+# No default value.
+DOCS_REQUIREMENTS?=myst_parser sphinxcontrib.mermaid shibuya sphinx-design sphinx-copybutton
+
+##############################################################################
+# END SETTINGS - DO NOT EDIT BELOW THIS LINE
+##############################################################################
+
+INSTALL_TARGETS?=
+DIRTY_TARGETS?=
+CLEAN_TARGETS?=
+PURGE_TARGETS?=
+
+export PATH:=$(if $(EXTRA_PATH),$(EXTRA_PATH):,)$(PATH)
+
+# Helper variable: adds trailing slash to PROJECT_PATH_PYTHON only if non-empty
+PYTHON_PROJECT_PREFIX=$(if $(PROJECT_PATH_PYTHON),$(PROJECT_PATH_PYTHON)/,)
+
+# Defensive settings for make: https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+# for Makefile debugging purposes add -x to the .SHELLFLAGS
+.SHELLFLAGS:=-eu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
+
+# mxmake folder
+MXMAKE_FOLDER?=.mxmake
+
+# Sentinel files
+SENTINEL_FOLDER?=$(MXMAKE_FOLDER)/sentinels
+SENTINEL?=$(SENTINEL_FOLDER)/about.txt
+$(SENTINEL): $(firstword $(MAKEFILE_LIST))
+	@mkdir -p $(SENTINEL_FOLDER)
+	@echo "Sentinels for the Makefile process." > $(SENTINEL)
+
+##############################################################################
+# mxenv
+##############################################################################
+
+OS?=
+
+# Determine the executable path
+ifeq ("$(VENV_ENABLED)", "true")
+export VIRTUAL_ENV=$(abspath $(VENV_FOLDER))
+ifeq ("$(OS)", "Windows_NT")
+VENV_EXECUTABLE_FOLDER=$(VIRTUAL_ENV)/Scripts
+else
+VENV_EXECUTABLE_FOLDER=$(VIRTUAL_ENV)/bin
+endif
+export PATH:=$(VENV_EXECUTABLE_FOLDER):$(PATH)
+MXENV_PYTHON=python
+else
+MXENV_PYTHON=$(PRIMARY_PYTHON)
+endif
+
+# Determine the package installer with non-interactive flags
+ifeq ("$(PYTHON_PACKAGE_INSTALLER)","uv")
+PYTHON_PACKAGE_COMMAND=uv pip --no-progress
+else
+PYTHON_PACKAGE_COMMAND=$(MXENV_PYTHON) -m pip
+endif
+
+# Auto-detect global uv availability (simple existence check)
+ifeq ("$(PYTHON_PACKAGE_INSTALLER)","uv")
+UV_AVAILABLE:=$(shell command -v uv >/dev/null 2>&1 && echo "true" || echo "false")
+else
+UV_AVAILABLE:=false
+endif
+
+# Determine installation strategy
+# depending on the PYTHON_PACKAGE_INSTALLER and UV_AVAILABLE
+# - both vars can be false or
+# - one of them can be true,
+# - but never boths.
+USE_GLOBAL_UV:=$(shell [[ "$(PYTHON_PACKAGE_INSTALLER)" == "uv" && "$(UV_AVAILABLE)" == "true" ]] && echo "true" || echo "false")
+USE_LOCAL_UV:=$(shell [[ "$(PYTHON_PACKAGE_INSTALLER)" == "uv" && "$(UV_AVAILABLE)" == "false" ]] && echo "true" || echo "false")
+
+# Check if global UV is outdated (non-blocking warning)
+ifeq ("$(USE_GLOBAL_UV)","true")
+UV_OUTDATED:=$(shell uv self update --dry-run 2>&1 | grep -q "Would update" && echo "true" || echo "false")
+else
+UV_OUTDATED:=false
+endif
+
+MXENV_TARGET:=$(SENTINEL_FOLDER)/mxenv.sentinel
+$(MXENV_TARGET): $(SENTINEL)
+	# Validation: Check Python version if not using global uv
+ifneq ("$(USE_GLOBAL_UV)","true")
+	@$(PRIMARY_PYTHON) -c "import sys; vi = sys.version_info; sys.exit(1 if (int(vi[0]), int(vi[1])) >= tuple(map(int, '$(PYTHON_MIN_VERSION)'.split('.'))) else 0)" \
+		&& echo "Need Python >= $(PYTHON_MIN_VERSION)" && exit 1 || :
+else
+	@echo "Using global uv for Python $(UV_PYTHON)"
+endif
+	# Validation: Check VENV_FOLDER is set if venv enabled
+	@[[ "$(VENV_ENABLED)" == "true" && "$(VENV_FOLDER)" == "" ]] \
+		&& echo "VENV_FOLDER must be configured if VENV_ENABLED is true" && exit 1 || :
+	# Validation: Check uv not used with system Python
+	@[[ "$(VENV_ENABLED)" == "false" && "$(PYTHON_PACKAGE_INSTALLER)" == "uv" ]] \
+		&& echo "Package installer uv does not work with a global Python interpreter." && exit 1 || :
+	# Warning: Notify if global UV is outdated
+ifeq ("$(UV_OUTDATED)","true")
+	@echo "WARNING: A newer version of uv is available. Run 'uv self update' to upgrade."
+endif
+
+	# Create virtual environment
+ifeq ("$(VENV_ENABLED)", "true")
+ifeq ("$(VENV_CREATE)", "true")
+ifeq ("$(USE_GLOBAL_UV)","true")
+	@echo "Setup Python Virtual Environment using global uv at '$(VENV_FOLDER)'"
+	@uv venv --allow-existing --no-progress -p $(UV_PYTHON) --seed $(VENV_FOLDER)
+else
+	@echo "Setup Python Virtual Environment using module 'venv' at '$(VENV_FOLDER)'"
+	@$(PRIMARY_PYTHON) -m venv $(VENV_FOLDER)
+	@$(MXENV_PYTHON) -m ensurepip -U
+endif
+endif
+else
+	@echo "Using system Python interpreter"
+endif
+
+	# Install uv locally if needed
+ifeq ("$(USE_LOCAL_UV)","true")
+	@echo "Install uv in virtual environment"
+	@$(MXENV_PYTHON) -m pip install uv
+endif
+
+	# Install/upgrade core packages
+	@$(PYTHON_PACKAGE_COMMAND) install -U pip setuptools wheel
+	@echo "Install/Update MXStack Python packages"
+	@$(PYTHON_PACKAGE_COMMAND) install -U $(MXDEV) $(MXMAKE)
+	@touch $(MXENV_TARGET)
+
+.PHONY: mxenv
+mxenv: $(MXENV_TARGET)
+
+.PHONY: mxenv-dirty
+mxenv-dirty:
+	@rm -f $(MXENV_TARGET)
+
+.PHONY: mxenv-clean
+mxenv-clean: mxenv-dirty
+ifeq ("$(VENV_ENABLED)", "true")
+ifeq ("$(VENV_CREATE)", "true")
+	@rm -rf $(VENV_FOLDER)
+endif
+else
+	@$(PYTHON_PACKAGE_COMMAND) uninstall -y $(MXDEV)
+	@$(PYTHON_PACKAGE_COMMAND) uninstall -y $(MXMAKE)
+endif
+
+INSTALL_TARGETS+=mxenv
+DIRTY_TARGETS+=mxenv-dirty
+CLEAN_TARGETS+=mxenv-clean
+
+##############################################################################
+# sphinx
+##############################################################################
+
+# additional targets required for building docs.
+DOCS_TARGETS+=
+
+SPHINX_BIN=sphinx-build
+SPHINX_AUTOBUILD_BIN=sphinx-autobuild
+
+DOCS_TARGET:=$(SENTINEL_FOLDER)/sphinx.sentinel
+$(DOCS_TARGET): $(MXENV_TARGET)
+	@echo "Install Sphinx"
+	@$(PYTHON_PACKAGE_COMMAND) install -U sphinx sphinx-autobuild $(DOCS_REQUIREMENTS)
+	@touch $(DOCS_TARGET)
+
+.PHONY: docs
+docs: $(DOCS_TARGET) $(DOCS_TARGETS)
+	@echo "Build sphinx docs"
+	@$(SPHINX_BIN) $(DOCS_SOURCE_FOLDER) $(DOCS_TARGET_FOLDER)
+
+.PHONY: docs-live
+docs-live: $(DOCS_TARGET) $(DOCS_TARGETS)
+	@echo "Rebuild Sphinx documentation on changes, with live-reload in the browser"
+	@$(SPHINX_AUTOBUILD_BIN) $(DOCS_SOURCE_FOLDER) $(DOCS_TARGET_FOLDER)
+
+.PHONY: docs-linkcheck
+docs-linkcheck: $(DOCS_TARGET) $(DOCS_TARGETS)
+	@echo "Run Sphinx linkcheck"
+	@$(SPHINX_BIN) -b linkcheck $(DOCS_SOURCE_FOLDER) $(DOCS_LINKCHECK_FOLDER)
+
+.PHONY: docs-dirty
+docs-dirty:
+	@rm -f $(DOCS_TARGET)
+
+.PHONY: docs-clean
+docs-clean: docs-dirty
+	@test -e $(MXENV_PYTHON) && $(MXENV_PYTHON) -m pip uninstall -y \
+		sphinx sphinx-autobuild $(DOCS_REQUIREMENTS) || :
+	@rm -rf $(DOCS_TARGET_FOLDER)
+
+INSTALL_TARGETS+=$(DOCS_TARGET)
+DIRTY_TARGETS+=docs-dirty
+CLEAN_TARGETS+=docs-clean
+
+##############################################################################
+# Custom includes
+##############################################################################
+
+-include $(INCLUDE_MAKEFILE)
+
+##############################################################################
+# Default targets
+##############################################################################
+
+INSTALL_TARGET:=$(SENTINEL_FOLDER)/install.sentinel
+$(INSTALL_TARGET): $(INSTALL_TARGETS)
+	@touch $(INSTALL_TARGET)
+
+.PHONY: install
+install: $(INSTALL_TARGET)
+	@touch $(INSTALL_TARGET)
+
+.PHONY: run
+run: $(RUN_TARGET)
+
+.PHONY: deploy
+deploy: $(DEPLOY_TARGETS)
+
+.PHONY: dirty
+dirty: $(DIRTY_TARGETS)
+	@rm -f $(INSTALL_TARGET)
+
+.PHONY: clean
+clean: dirty $(CLEAN_TARGETS)
+	@rm -rf $(CLEAN_TARGETS) $(MXMAKE_FOLDER) $(CLEAN_FS)
+
+.PHONY: purge
+purge: clean $(PURGE_TARGETS)
+
+.PHONY: runtime-clean
+runtime-clean:
+	@echo "Remove runtime artifacts, like byte-code and caches."
+	@find . -name '*.py[c|o]' -delete
+	@find . -name '*~' -exec rm -f {} +
+	@find . -name '__pycache__' -exec rm -fr {} +
+