Skip to content

Vijfpas Docs

Public platform portal

Platform and infrastructure reference from one docs tree.

This site is published directly from the authoritative monorepo docs/ tree. Use it for the public-facing platform model and the live infrastructure baseline that teams build on.

Source of truth
the monorepo docs/ tree

Audience
operators, platform builders, delivery teams, tenants

Publishing model
static site on k8s-prd, no in-app editing

Public split

The public docs site is now split into two tracks:

  • Platform for architecture, services, products, security, HA, and operating model.
  • Infrastructure for the live environment baseline: deployments, network, interfaces, bootstrap, and inventory.

This is cleaner than a raw infra vs platform split in the source tree because the authored documents still keep the stricter internal distinction of architecture/policy vs implementation, while the public site exposes them in the two categories people actually navigate.

Runbooks and ADRs remain in the monorepo as authoritative internal material, but they are not published on this public portal.

Start here

Core document paths

Path Use it for
platform.md the public platform map
services.md shared platform service baselines
products.md product and tenant-facing components
implementation.md the public infrastructure map
implementation-deployments.md current deployment facts only
implementation-network.md VLANs, DNS, firewall, and routing facts

Working rules

  • Treat this site as a published view, not the authoring surface.
  • Change the authoritative content in the monorepo first.
  • Use the live implementation docs for current state; use Git history for older state.
  • Runbooks and ADRs stay authoritative in Git, but they are intentionally not part of the public portal.
  • Keep service changes and documentation changes in the same delivery window.