Repository navigation
docs: quote the network label error in the guide, not just describe it - #45
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.networkappeared nowhere on the published site: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:
docker network create. Remove it.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 --strictexit 0.