Skip to content

Leftover AWS terminology and filenames in shipped docs #68

Description

@baonguyenNava

Summary

template-infra-azure is derived from the AWS template-infra, and several shipped operational docs still carry AWS-specific terminology and filenames that don't match the actual Azure implementation. The infra is azurerm-backed (<env>.azurerm.tfbackend, e.g. infra/example.azurerm.tfbackend) and uses Azure Container Apps / Container App Jobs, Azure Key Vault, Azure Storage (blob), and Virtual Networks — but the docs reference S3, Lambda, ECS, etc.

These are confusing for new users who follow the docs literally (e.g. passing a dev.s3.tfbackend file that doesn't exist).

Examples found

  • making-infra-changes.md — shows terraform init -backend-config=dev.s3.tfbackend. The correct Azure backend file is <env>.azurerm.tfbackend.
  • destroy-infrastructure.md — same dev.s3.tfbackend leftover; should be <env>.azurerm.tfbackend.
  • set-up-database.md (step 4) — calls the database role manager a "Lambda function." On Azure the role manager is a Container App Job.
  • General terminology across shipped docs — references to "ECS task", "Lambda function", "S3", "VPC", and "ECR" that map to Azure equivalents (Container Apps/Jobs, Azure Storage blob, Virtual Networks, Azure Container Registry).

Suggested fix

Sweep the shipped docs/ for AWS resource names (s3, tfbackend filenames, Lambda, ECS, ECR, VPC) and replace with their Azure equivalents, cross-checking against docs/system-architecture.md.


Filed from observations while documenting this template in the Strata Documentation Engine.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions