Normalize inline comments across compose and env templates #32

Merged

MHE merged 2 commits from review-comments-spelling-check into main

2026-11-10 10:08:55 +01:00

MHE commented

2026-11-10 10:06:26 +01:00

Owner

What changed

Comment-only cleanup across the Docker Compose stacks, .env templates, and Traefik dynamic config. No image tags, ports, env values, volumes, capabilities, or network membership were intentionally changed.

Corrected inline comments that no longer matched the lines they describe, such as the APP_PASSWORD_PATH and secrets notes in ServiceQuote, the APP_IMAGE notes on satellite services, the NET_BIND_SERVICE and ports examples in the Redis templates, and the hostname note in forgejo-runner-token.
Fixed grammar and wording, e.g. GOES to GO, selects to select, permission checks to ownership checks for FOWNER, and the Traefik SNI notes.
Added or removed placeholder comments on structural lines, such as options:, the security_opt anchor, and the commented volumes: and networks: blocks.

Why

Inline comments are the operator-facing documentation for these templates. Several had become stale after recent changes to satellite services and secret handling, which could mislead operators. The rest tidies the same text.

Review notes

Please skim the diff for any accidental edits to non-comment lines, and confirm the Traefik priority and sniStrict comment changes read correctly.

## What changed Comment-only cleanup across the Docker Compose stacks, `.env` templates, and Traefik dynamic config. No image tags, ports, env values, volumes, capabilities, or network membership were intentionally changed. - Corrected inline comments that no longer matched the lines they describe, such as the `APP_PASSWORD_PATH` and `secrets` notes in ServiceQuote, the `APP_IMAGE` notes on satellite services, the `NET_BIND_SERVICE` and `ports` examples in the Redis templates, and the `hostname` note in forgejo-runner-token. - Fixed grammar and wording, e.g. `GOES` to `GO`, `selects` to `select`, `permission checks` to `ownership checks` for FOWNER, and the Traefik SNI notes. - Added or removed placeholder comments on structural lines, such as `options:`, the `security_opt` anchor, and the commented `volumes:` and `networks:` blocks. ## Why Inline comments are the operator-facing documentation for these templates. Several had become stale after recent changes to satellite services and secret handling, which could mislead operators. The rest tidies the same text. ## Review notes Please skim the diff for any accidental edits to non-comment lines, and confirm the Traefik `priority` and `sniStrict` comment changes read correctly.

MHE added 2 commits

2026-11-10 10:06:26 +01:00

Fix spelling and comment wording in compose, env, and TLS config 771a9fc312

Reword inline comments in compose and env templates

ci / compose (pull_request) Successful in 15s

Details

ci / shellcheck (pull_request) Successful in 7s

Details

ci / conventions (pull_request) Successful in 2s

Details

ci / image (pull_request) Successful in 1s

Details