Backstage Template Guide

The ngss-backstage-template generates Backstage catalog entries and documentation structure for VA Mobile Health services.

What It Generates

  • catalog-info.yaml - Backstage catalog entity definition

  • docs/ - MkDocs-based documentation structure

  • mkdocs.yml - MkDocs configuration (if using TechDocs)

  • API definitions (optional)

Quick Start

# Copier CLI
copier copy https://coderepo.mobilehealth.va.gov/scm/ckm/ngss-backstage-template.git . --trust

# Or using Maven
mvn filegen:copier-init -Dcopier.template=backstage

The template auto-detects settings from your pom.xml and prompts for Backstage-specific options like owner team, lifecycle stage, and API definitions.

Updating Your Project

# Copier CLI - Update to latest template version
copier update -a .copier-answers/backstage.yaml

# Maven equivalent
mvn filegen:copier-update -Dcopier.template=backstage

# Re-prompt specific questions (Copier CLI)
copier update --ask lifecycle --ask owner -a .copier-answers/backstage.yaml

Using with DevOps Template

Both templates work together and store answers separately:

# Copier CLI - Set up DevOps first (Kubernetes/Skaffold)
copier copy https://coderepo.mobilehealth.va.gov/scm/ckm/ngss-devops-template.git .

# Then add Backstage catalog entry
copier copy https://coderepo.mobilehealth.va.gov/scm/ckm/ngss-backstage-template.git . --trust

# Or using Maven (initializes both devops and backstage)
mvn filegen:copier-init
.copier-answers/
├── devops.yaml      # DevOps template answers
└── backstage.yaml   # Backstage template answers