Skip to content

docs: enrich docs for modules#1167

Merged
mdelapenya merged 9 commits intotestcontainers:mainfrom
mdelapenya:enrich-module-docs
May 11, 2023
Merged

docs: enrich docs for modules#1167
mdelapenya merged 9 commits intotestcontainers:mainfrom
mdelapenya:enrich-module-docs

Conversation

@mdelapenya
Copy link
Copy Markdown
Member

What does this PR do?

This PR updates the docs for the modules so that all of them follow the same structure.

Why is it important?

The code generator provides a consistent structure for the docs, including the common customizers that the core library exposes. We want a consistent experience consuming the docs for all modules.

@mdelapenya mdelapenya requested a review from a team as a code owner May 11, 2023 09:05
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label May 11, 2023
@mdelapenya mdelapenya self-assigned this May 11, 2023
@netlify
Copy link
Copy Markdown

netlify bot commented May 11, 2023

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit e6c4964
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/645cafc2041e1a0008d39509
😎 Deploy Preview https://deploy-preview-1167--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 settings.

@sonarqubecloud
Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@mdelapenya mdelapenya changed the title docs: enrich docs for mdules docs: enrich docs for modules May 11, 2023
@mdelapenya mdelapenya merged commit 7ea62d8 into testcontainers:main May 11, 2023
@mdelapenya mdelapenya deleted the enrich-module-docs branch May 11, 2023 10:21
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request May 11, 2023
* main:
  docs: enrich docs for modules (testcontainers#1167)
  chore: prepare for next minor development cycle (0.21.0)
  chore: use new version (v0.20.1) in modules and examples
  Revert "fix: don't panic when logs waits for more than 5 seconds (testcontainers#947)" (testcontainers#1164)
  fix: define a two-phase release process (testcontainers#1163)
  ci(lint): enable misspell and gci linters (testcontainers#1162)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, docs, docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant