📚 Add TechDocs Documentation

[backstage-cds-snc]

Add TechDocs Configuration

This PR adds TechDocs support to the repository.

Changes

• ✅ Added mkdocs.yml configuration
• ✅ Created docs/ directory with initial documentation
• ✅ Added GitHub Actions workflow for TechDocs publishing
• ✅ Added helper script for extracting catalog entity info
• ✅ Added catalog-info.yaml with TechDocs configuration (if applicable)

⚠️ IMPORTANT: If your repository already has a catalog-info.yaml file, you MUST manually add the TechDocs annotation after merging.

What is TechDocs?

TechDocs is Backstage's built-in documentation solution that creates beautiful documentation sites from Markdown files.

Next Steps

1. Review the changes in this PR
2. Customize docs/index.md with your content if you want it to be different from README.md
3. Merge this PR to enable TechDocs
4. View your docs in Backstage!

If catalog-info.yaml ALREADY exists:

You need to check if it has the TechDocs annotation and add it if missing.

Required Manual Step

Add the following line under metadata.annotations in your existing catalog-info.yaml ONLY if missing:

metadata:
annotations:
    backstage.io/techdocs-ref: dir:.

Why is this manual?

Backstage scaffolder templates use replace: false to protect your existing files. This means:

• If you don't have a catalog-info.yaml, we create one with the annotation
• If you already have one, we don't modify it (to prevent accidental data loss)

Example

Before:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: my-component
annotations:
    github.com/project-slug: cds-snc/my-repo
spec:
type: service
owner: my-team

After:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: my-component
annotations:
    github.com/project-slug: cds-snc/my-repo
    backstage.io/techdocs-ref: dir:.  # ← ADD THIS LINE
spec:
type: service
owner: my-team

Created by: Backstage Scaffolder Template 📖