Skip to content

docs: quote the network label error in the guide, not just describe it - #45

Merged
jravani merged 1 commit into
mainfrom
docs/quote-network-label-error
Sep 17, 2026
Merged

jravani merged 1 commit into
mainfrom
docs/quote-network-label-error

Conversation

@jravani

@jravani jravani commented Sep 17, 2026

Copy link
Copy Markdown
Member

Follow-up to #44, one paragraph in the getting-started guide, no behaviour change.

#44 said the error text was recorded in the compose files, the guide and ADR-005. It was in the first and last only. The guide described the failure without quoting it, so the string com.docker.compose.network appeared nowhere on the published site:

published getting-started page, before:  0 occurrences
after:                                   1

That misses the reader #44 was written for. A compose file is greppable only with the repository already checked out, and the arc42 ADR ships as a PDF. The guide is the published page someone lands on after pasting an error message into a search, which was the whole stated purpose.

The message is now quoted, and the two cases are distinguished by the value it reports rather than by prose, since they need different fixes:

  • empty label: the network was created outside Compose, by docker network create. Remove it.
  • any other value: a compose file declared the network under a different key. Compose compares the key, not the name:.

Verified the string survives into the rendered HTML rather than only into the Markdown source, which is the mistake that produced this in the first place. mkdocs build --strict exit 0.

The previous change claimed the error text was in the compose files, the
guide and ADR-005. It was in the first and last only; the guide described
the error without quoting it. That misses the reader it was written for.
A compose file is greppable only with the repository to hand and the ADR
ships as a PDF, while the guide is the published page someone reaches
after pasting the message into a search.

The message is now quoted, and the two cases are distinguished by the
value it reports rather than by prose: an empty label means the network
was created outside Compose, any other value means a different key.
Confirmed the string survives into the rendered HTML.
@jravani
jravani merged commit 883dd3a into main Sep 17, 2026
2 checks passed
@jravani
jravani deleted the docs/quote-network-label-error branch September 17, 2026 11:45
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.

1 participant