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

docs: improve contributing docs for code snippets #2546

Merged
merged 2 commits into from
May 20, 2024

Conversation

mdelapenya
Copy link
Collaborator

@mdelapenya mdelapenya commented May 20, 2024

What does this PR do?

It adds docs for the codesnippet plugin: https://github.com/rnorth/mkdocs-codeinclude-plugin

Render URL: https://deploy-preview-2546--testcontainers-go.netlify.app/contributing_docs/

Why is it important?

Enhance the docs contribution experience.

@mdelapenya mdelapenya requested a review from a team as a code owner May 20, 2024 13:06
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label May 20, 2024
@mdelapenya mdelapenya self-assigned this May 20, 2024
Copy link

netlify bot commented May 20, 2024

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 1507498
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/664b5a972c86c20007cce43d
😎 Deploy Preview https://deploy-preview-2546--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.

docs/contributing_docs.md Outdated Show resolved Hide resolved
@mdelapenya mdelapenya merged commit 4efa1e7 into testcontainers:main May 20, 2024
7 checks passed
@mdelapenya mdelapenya deleted the document-codesnippet branch May 20, 2024 14:30
mdelapenya added a commit to bearrito/testcontainers-go that referenced this pull request Jun 11, 2024
* main: (48 commits)
  Fix race condition when looking up reaper (ryuk) container (testcontainers#2508)
  chore: bring golangci-lint back (testcontainers#2571)
  docs(compose): Fix typo docker compose docs (testcontainers#2565)
  Handle error properly during port forwarding initialization. (testcontainers#2550)
  chore: pin vearch version (testcontainers#2568)
  feat: add vearch module (testcontainers#2560)
  chore: run tests against latest Docker engine, nightly (testcontainers#2566)
  chore(deps): bump mkdocs-include-markdown-plugin from 6.0.4 to 6.0.7 (testcontainers#2562)
  Fix network accessor for port-forwarding feature (testcontainers#2551)
  --- (testcontainers#2549)
  fix: update search bar eval in mkdocs (testcontainers#2547)
  docs: improve contributing docs for code snippets (testcontainers#2546)
  chore: use a virtualenv for working with the docs site (testcontainers#2545)
  docs: document test session semantics (testcontainers#2544)
  feat(ryuk): allow to configure ryuk timeouts using env variables (testcontainers#2541)
  docs: fix CircleCI docs (testcontainers#2539)
  fix: add import to module generation (testcontainers#2537)
  chore: prepare for next minor development cycle (0.32.0)
  chore: use new version (v0.31.0) in modules and examples
  feat(mongodb): add replica set support via opts (testcontainers#2469)
  ...
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.

None yet

1 participant