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

# From your project directory
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

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

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

Using with DevOps Template

Both templates work together and store answers separately:

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

# Then add Backstage catalog entry
copier copy https://coderepo.mobilehealth.va.gov/scm/ckm/ngss-backstage-template.git . --trust
.copier-answers/
├── devops.yaml      # DevOps template answers
└── backstage.yaml   # Backstage template answers

Full Documentation

For detailed information including:

  • All configuration options

  • Entity types and relationships

  • TechDocs setup

  • API definitions

  • Troubleshooting

See the ngss-backstage-template documentation.