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: indicate version for the Run function #2627

Merged
merged 3 commits into from
Jul 5, 2024

Conversation

mdelapenya
Copy link
Member

  • docs: indicate version for the Run function
  • docs(cockroachdb): move info message to the right section

What does this PR do?

It adds the version in which the Run function was added (currently main, the release process will update to the new one).

It also adds a deprecation message for the RunContainer function next to the above message.

Why is it important?

Users could be confused by the current docs system, which is not ready yet for supporting multiversion. And because of that, it renders from the main branch.

Related issues

@mdelapenya mdelapenya requested a review from a team as a code owner July 5, 2024 06:44
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Jul 5, 2024
@mdelapenya mdelapenya self-assigned this Jul 5, 2024
Copy link

netlify bot commented Jul 5, 2024

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 52e2df3
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/66879abb4021f6000885bec0
😎 Deploy Preview https://deploy-preview-2627--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.

@mdelapenya mdelapenya merged commit 3f73722 into testcontainers:main Jul 5, 2024
108 checks passed
@mdelapenya mdelapenya deleted the docs-new-api-version branch July 11, 2024 11:48
mdelapenya added a commit that referenced this pull request Jul 15, 2024
* main:
  fix: log output after context timeout (#2643)
  chore(deps): use "github.com/containerd/platforms" instead (#2638)
  chore(deps): bump google.golang.org/grpc to 1.64.1 (#2635)
  chore(deps): bump certifi from 2024.2.2 to 2024.7.4 (#2631)
  chore: prepare for next minor development cycle (0.33.0)
  chore: use new version (v0.32.0) in modules and examples
  feat: honour go toolchain's verbose flag to print out logs (#2624)
  Fix issues in BuildImage() (#2626)
  docs: indicate version for the Run function (#2627)
  chore: remove duplicated tests for config (#2628)
  Log retried errors (#2613)
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.

[Bug]: Hosted API docs are already for the new API and don't match with the latest go package version 0.31.0
1 participant