Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: networking basics #612

Merged
merged 3 commits into from Nov 4, 2022
Merged

docs: networking basics #612

merged 3 commits into from Nov 4, 2022

Conversation

mdelapenya
Copy link
Collaborator

What does this PR do?

It documents the networking basics:

  • exposing ports to the host
  • getting container host
  • advanced networking such as creating networks and attaching containers to them, including aliases

It uses the codeinclude mkdocs plugin, to embed code snippets demonstrating each feature.

This docs page is basically a copy from the Java one, but removing the section that explains how to bind a host port to the container.

Why is it important?

Docs, docs, docs!!

Related issues

@mdelapenya mdelapenya requested a review from a team as a code owner November 3, 2022 17:55
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Nov 3, 2022
@mdelapenya mdelapenya self-assigned this Nov 3, 2022
@mdelapenya mdelapenya changed the title docs: basic networking docs: networking basics Nov 3, 2022
kiview
kiview previously approved these changes Nov 4, 2022
View reviewed changes
docs/features/networking.md Outdated Show resolved Hide resolved
@kiview
Copy link
Member

kiview commented Nov 4, 2022

Docs look great in preview and I am very happy we can start to use code includes in testcontainers-go as well 🙂

@mdelapenya @kiview
fix: use function instead
f1b5c09 
Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>
@mdelapenya mdelapenya merged commit 5ff899f into testcontainers:main Nov 4, 2022
mdelapenya referenced this pull request in mdelapenya/testcontainers-go Nov 9, 2022
@mdelapenya
Merge branch 'main' into examples
ed0121e 
* main:
  docs: networking basics (#612)
  docs: wording in project name (#610)
  feat: Auth config for build images (#602)
  chore: sync governance files (#608)
@mdelapenya mdelapenya deleted the network-docs branch November 15, 2022 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kiview kiview kiview left review comments

@eddumelendez eddumelendez Awaiting requested review from eddumelendez

@HofmeisterAn HofmeisterAn Awaiting requested review from HofmeisterAn

Assignees

@mdelapenya mdelapenya

Labels
documentation Docs, docs, docs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs]: document networks
2 participants
@mdelapenya @kiview