Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

docs: refine texts on how to set the module image #3012

Merged
merged 5 commits into from
Mar 11, 2025
Merged

docs: refine texts on how to set the module image #3012

merged 5 commits into from
Mar 11, 2025

Conversation

mdelapenya
Copy link
Member

  • fix: remove outdated text from the module's docs template
  • docs: fix the texts to set the container image in modules
  • docs: use In example instead of E.g. in the image option

What does this PR do?

This PR refines two things:

  1. the module template for module docs: removing the outdated message for the old RunContainer function, which is not generated anymore.
  2. Change the text for the Image selection, as it was using the old message for using a different image, when in fact, it's the only way to specify the image.

Why is it important?

Consistency in the docs, and also not generating outdated texts.

@mdelapenya mdelapenya requested a review from a team as a code owner March 10, 2025 16:39
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Mar 10, 2025
@mdelapenya mdelapenya self-assigned this Mar 10, 2025
@mdelapenya mdelapenya requested a review from stevenh March 10, 2025 16:39
@netlify Netlify
Copy link

netlify bot commented Mar 10, 2025 •
edited
Loading

✅ Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 197359b
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/67cfe75ae53e61000848063f
😎 Deploy Preview https://deploy-preview-3012--testcontainers-go.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

stevenh
stevenh approved these changes Mar 11, 2025
View reviewed changes
Copy link
Contributor

@stevenh stevenh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mdelapenya mdelapenya merged commit 023e6f7 into testcontainers:main Mar 11, 2025
21 checks passed
@mdelapenya mdelapenya deleted the modulegen-refinement branch March 11, 2025 08:56
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Mar 11, 2025
@mdelapenya
Merge branch 'main' into bring-back-dependabot
29cb0fa 
* main:
  docs: refine texts on how to set the module image (testcontainers#3012)
  feat(modules): add dind module (testcontainers#3004)
  docs: correct container variable (testcontainers#3010)
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Mar 11, 2025
@mdelapenya
Merge branch 'main' into azure-modules
25db8c1 
* main:
  docs: refine texts on how to set the module image (testcontainers#3012)
  feat(modules): add dind module (testcontainers#3004)
  docs: correct container variable (testcontainers#3010)
  chore: update Weaviate version to v1.29.0 and Weaviate Go client to v5.0.2 (testcontainers#3006)
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@stevenh stevenh stevenh approved these changes

Assignees

@mdelapenya mdelapenya

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

Successfully merging this pull request may close these issues.
2 participants
@mdelapenya @stevenh