Skip to content

Development Workflow

Overview

Keep changes in the repository that owns the behavior. Inventory, exporter code, Helm charts, runtime values, dashboards, alerts, and documentation have different deployment and review paths.

Branching Strategy

Branch from the latest main and keep the change scoped to one operational objective. Generated inventory artifacts should remain in the same pull request as their source change. Rebase stale branches before review.

Pull Request Standards

Every pull request should state:

  • problem and operational impact;
  • affected device roles, regions, services, and clusters;
  • source of truth changed;
  • test or generation command;
  • before/after evidence;
  • rollout and rollback plan;
  • security/data-handling considerations;
  • audit and documentation updates required.

Code Style & Linting

Use the linters, formatters, tests, and chart/config validation defined by the owning repository. Exporters must preserve stable metrics/labels and avoid unbounded cardinality. Generated files should be regenerated, not hand-edited, unless a manual exception is documented.

Local Development Setup

For this documentation repository:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve
mkdocs build --strict

A change is complete only when the runtime consumed it and the expected telemetry, dashboard, and alert behavior are verified.