docs: add consistent snippets for network creation #2703
Merged
Conversation
This file contains 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
✅ Deploy Preview for testcontainers-go ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kiview
approved these changes
Aug 8, 2024
mdelapenya
added a commit
that referenced
this pull request
Aug 9, 2024
* main: fix(compose): remove test volumes (#2712) chore(mysql): add missing error check in example (#2707) chore: remove unused params from defaultPreCreateHook (#2714) docs: improve docs for container methods (#2713) chore(registry): disable build log (#2711) chore: remove obsolete compose version (#2710) chore: improve lifecycle errors (#2708) docs: add consistent snippets for network creation (#2703) test: add retry on system error test (#2687) Redpanda Module: Add option for arbitrary bootstrap config (#2666) feat(inbucket): expose POP3 and wait for all ports (#2690) fix(wait): data race in test (#2698) fix(milvus): racy container setup (#2693) fix(mongodb): replica test failures (#2699) test: racy port creation in port forwarding tests (#2688) fix: port forwarding race condition (#2686)
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.
What does this PR do?
It separates the tests from the testable examples for the network creation, updating the docs to the new examples.
The new testable examples contain clearer code snippets for creating networks with and without options.
Render URL: https://deploy-preview-2703--testcontainers-go.netlify.app/features/creating_networks/#__tabbed_1_1
Why is it important?
Try to avoid confusing users reading our docs, as the default snippet used the internal option for creating networks, and this could cause issues when accessing the ports of containers in that internal network.
Follow-ups
Considering deprecating the functional option to make a network internal (which great power...)