EOEPCA Deployment Guide

See latest published version

This repository contains two related deliverables that are released together:

• docs/: the Deployment Guide content rendered with MkDocs.
• scripts/: deployment helper scripts for EOEPCA+ Building Blocks.

A tagged release in this repository represents a consistent version of both.

Release Strategy

Releases follow Semantic Versioning with repository tags in the form eoepca-MAJOR.MINOR (optionally eoepca-MAJOR.MINOR.PATCH).

For example, Release 2.0 is tagged as eoepca-2.0.

• MAJOR: reserved for governance-level exceptional EOEPCA+ release boundaries (for example major architecture transitions or contractual/programmatic phase changes).
• MINOR: new features/use-cases/components that do not meet MAJOR criteria.
• PATCH: backward-compatible corrections without capability expansion, including backward-compatible security vulnerability fixes.

The full policy is documented in docs/release-strategy.md.

Documentation Publication

The guide is written in Markdown and rendered through mkdocs, with site configuration in mkdocs.yml.

Published documentation is served via Read the Docs:

• latest tracks main.
• Tagged releases provide versioned documentation views.

Material Theme

The documentation is rendered with the Material Theme.

To avoid the need for a local installation of the mkdocs tooling and the Material for MkDocs theme, we have some local helper scripts that use a docker image squidfunk/mkdocs-material for this tooling.

Helper Script - serve

The script ./serve is used for local development of the docs - using the squidfunk/mkdocs-material docker image to invoke a local server to render the 'live' content from the docs/ subdirectory.

The local document is served from http://localhost:8000/.