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: go get latest (potentially untagged) module in quickstart #2830

Closed
wants to merge 1 commit into from

Conversation

rollulus
Copy link

Using a go get without the version installs the latest tagged release. The documentation on the website can be more recent, potentially relying on functionality that's not in the latest tagged release yet.

What does this PR do?

Instruct to go get @main in quickstart.

Why is it important?

Using a go get without the version installs the latest tagged release. The documentation on the website can be more recent, potentially relying on functionality that's not in the latest tagged release yet.

Related issues

#511

Using a go get without the version installs the latest tagged release.
The documentation on the website can be more recent, potentially relying
on functionality that's not in the latest tagged release yet.
@rollulus rollulus requested a review from a team as a code owner October 16, 2024 16:29
Copy link

netlify bot commented Oct 16, 2024

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 548f2c5
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/670fe9ea69481e00081a32aa
😎 Deploy Preview https://deploy-preview-2830--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.

Copy link
Collaborator

@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.

I understand the intent, but IMO we shouldn't be encouraging folks to use main unless they have a specific need, e.g. testing an unreleased feature.

Instead I would make it clear that the docs here could include unreleased changes, which should be clearly documented and point them towards the pkg.go.dev which provides versioned documentation if they need to validate.

@mdelapenya thoughts?

@mdelapenya
Copy link
Member

mdelapenya commented Oct 16, 2024

@stevenh you are right. Given #511 is still around, regarding the docs system and the multiversion system, I'd consider our website as a best effort towards sharing knowledge about main. From the modules standpoint, we always try to add the version functions and methods appeared for a given module, which is what pkg.go.dev did pretty well. So, following on @stevenh's advice, we could add that message linking to pkg.go.dev in the quickstart guide, with the warning regarding the versioning.

I think I can dedicate time to look at #511 again, but I'll be after the ongoing PRs regarding the reaper and the new modules.

@rollulus
Copy link
Author

Ok, got it, I think this then ends what I can do as a random visitor. Thanks.

@rollulus rollulus closed this Oct 17, 2024
@mdelapenya
Copy link
Member

In any case thanks @rollulus for your random visit :) I helped us in talking again about #511

Please come again and provide any feedback you consider, specially about docs. We are doing our best in keeping them up-to-date, but many times is difficult because of the bandwidth.

Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants