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.

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

chore: include how to install the module in the generated docs #991

Merged
merged 1 commit into from
Mar 27, 2023

Conversation

mdelapenya
Copy link
Member

What does this PR do?

It adds a dedicated section in the docs for a new module (or example module) to demonstrate how to install the module.

Why is it important?

Enrich the generated code for a new module.

Related issues

@mdelapenya mdelapenya requested a review from a team as a code owner March 27, 2023 10:43
@mdelapenya mdelapenya added the chore Changes that do not impact the existing functionality label Mar 27, 2023
@mdelapenya mdelapenya self-assigned this Mar 27, 2023
@netlify
Copy link

netlify bot commented Mar 27, 2023

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit a0e7384
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/64217360bc78d30007e7f494
😎 Deploy Preview https://deploy-preview-991--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.

@sonarcloud
Copy link

sonarcloud bot commented Mar 27, 2023

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 merged commit f1d8f5e into testcontainers:main Mar 27, 2023
@mdelapenya mdelapenya deleted the module-docs-generator branch March 28, 2023 07:40
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Mar 28, 2023
* main:
  chore: skip CI builds when updating the docs (testcontainers#996)
  chore: render logos from the base location (testcontainers#995)
  chore: include how to install the module in the generated docs (testcontainers#991)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Changes that do not impact the existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant