Skip to content

docs(install): correct the Azure asset-repository limitation and file layout - #26

Merged
jcastiarena merged 1 commit into
mainfrom
fix/install-docs-asset-repo-and-layout
Sep 9, 2026
Merged

docs(install): correct the Azure asset-repository limitation and file layout#26
jcastiarena merged 1 commit into
mainfrom
fix/install-docs-asset-repo-and-layout

Conversation

@jcastiarena

@jcastiarena jcastiarena commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #20, which landed the Azure install reference with two documentation defects. Docs only — no HCL or workflow changes.

1. The asset-repository limitation named the wrong specifications

Both READMEs listed s3-configuration as one of the available asset-repository provider specifications. It is not one.

Checking the provider catalogue, exactly two specifications take the asset-repository role — the ones whose mapping writes repository_provider to global.asset_repository_provider:

slug name asset URL shape
ecr AWS ECR image URI
docker-server Docker Server image URI

s3-configuration declares no such mapping at all. It maps bucket.name to aws.s3_assets_bucket, and that is what makes the AWS path resolve to the s3://… URL deployment/distribution/cloudfront/setup parses.

Conflating the two categories obscured what Azure actually needs. The corrected text states it: either an Azure Blob asset-repository provider, or an azure-blob-configuration counterpart to s3-configuration. The limitation itself is unchanged and still real — a deployment cannot complete on Azure, because both available asset repositories are container-registry shaped and blob-cdn/setup rejects an image URI.

The full explanation now lives in static-files/README.md only; specs/install/README.md carries a two-line version and links to it. Keeping the same claim written out twice is how it came to be wrong in two places at once.

2. The layout tree had drifted from the directories it documents

It was missing azure/provider.tf (added late in #20), and aws/ had since gained provider.tf and versions.tf from #19. Both examples now carry the same five files, and the tree says so.

Verification

The tree is checked against git ls-files rather than the working directory — azure/ also holds a gitignored .terraform/ and .terraform.lock.hcl from a local tofu init, which must not appear in the documented layout:

aws/    OK  (5 tracked files)
azure/  OK  (5 tracked files)

No s3-configuration mention remains except the two that explain what it actually is.

🤖 Generated with Claude Code

… layout

Two documentation defects that landed with the Azure install reference.

The limitation named `s3-configuration` as one of the available asset-repository
provider specifications. It is not one: it declares no
`global.asset_repository_provider` mapping at all, it maps `bucket.name` to
`aws.s3_assets_bucket` — which is what makes the AWS path resolve to the `s3://`
URL `cloudfront/setup` parses. The specifications that do take the
asset-repository role are `ecr` and `docker-server`, both container-registry
shaped. Mixing the two categories obscured what Azure actually needs: either a
Blob asset-repository provider, or an `azure-blob-configuration` counterpart to
`s3-configuration`.

The layout tree also drifted from the directories it documents: it was missing
`azure/provider.tf`, and `aws/` had since gained `provider.tf` and `versions.tf`.
Both examples now carry the same five files and the tree says so.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jcastiarena jcastiarena changed the title docs(install): correct the Azure asset-repository limitation and file layout docs(install): correct the Azure asset-repository limitation, fix the layout tree, and guard it in CI Sep 8, 2026
@jcastiarena
jcastiarena force-pushed the fix/install-docs-asset-repo-and-layout branch from 4fdc8e5 to 0b237da Compare September 9, 2026 12:05
@jcastiarena jcastiarena changed the title docs(install): correct the Azure asset-repository limitation, fix the layout tree, and guard it in CI docs(install): correct the Azure asset-repository limitation and file layout Sep 9, 2026
@jcastiarena
jcastiarena merged commit 83afd2c into main Sep 9, 2026
9 checks passed
@jcastiarena
jcastiarena deleted the fix/install-docs-asset-repo-and-layout branch September 9, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants