Step-by-Step Guide

Follow these chapters in order when building a new domain registry

1

Plan your domain

Map registers (REGISTER, TABLE, CORE_TABLE), choose PascalCase mnemonics, and decide mixins, functional IDs, dedup, and optional ingestion or scores before any code.

2

Scaffold the repository

Create the domain repo with {variant}-extension/, docker/, helm/openg2p-{variant}/, and path-scoped GitHub workflows matching reference implementations.

3

Configure extensions package

Configure pyproject.toml for the openg2p_registry_extensions alias, wire app.py (core init, factory, migrations), and optional config, ID generator, enrichers, or scores.

4

Build models, schemas and services

Implement the classes set per mnemonic - live, history, and intake ORM; matching Pydantic schemas; domain services with validation and display hooks.

5

Generate metadata and sample data

Author SQL under meta_data/ for definitions, section UI JSON, tabs, intake forms, lookups, and optional ingestion rules; upload Jinja to MinIO; add sample data under sample_data/register_data/ for development environments.

6

Build docker images

Build domain branded images via service spec files (domain extensions), bundling the extension with pinned platform packages (API, partner, Celery, UI, db-seed).

7

Construct helm charts

Wrap the base openg2p-registry chart with your image repositories, idTypes, optional Rancher questions.yaml, and sample-data toggle to create a deploy-able chart over base.

8

Post Install workflow

Working examples live in Reference implementations.