[Enhancement]: Release docs from release tag

[anuraaga]

Proposal

I noticed this page in the docs that mentions the Files: pattern of precopying files

https://golang.testcontainers.org/features/copy_file/

But this isn't in the latest release tag v0.13.0 so it's confusing that the API can't be used. I think the docs are tagged together with the code in this repo, so perhaps they could be released from the tag as well.

[mdelapenya]

Hi @anuraaga thanks for proposing this change, which I can share with you is a topic of high interest to us internally.

I agree with you it could lead to confusion and eventual disappointment, but there are reasons nowadays that impede us to do it in a different manner.

First, having the docs living in the same repository makes it difficult (although not impossible) to sync releases and docs. Difficult in the sense that we do not want to cause overhead for contributors making them send separated PRs for the docs, or even split existing ones including them, as it could slow down the review&merge cycle.

Second, the process to merge those docs PRs at release time would need more manual work for the OSS team, or even create automation that does not exist at this moment, to make those docs PRs into the release.

I want to share with you that revamping the docs is on our radar as a team, not only for the Go project but for all the available languages, so this process will be eventually updated.

In the meantime, I'd ask for understanding there could be inconsistencies that hopefully do not prevent you from using the product 🙏

[anuraaga]

Thanks for the context @mdelapenya - I had just noticed that the docs folder is in this repository together with the code, which I believe is the website. Given that, isn't the versioning issue quite easy since a new feature can add docs in the exact same PR, and the code and docs would be tagged with a release together when ready? It looks fairly easy to keep in sync unless I'm missing something

[mdelapenya]

Given that, isn't the versioning issue quite easy since a new feature can add docs in the exact same PR, and the code and docs would be tagged with a release together when ready

Oh I probably did not mention, but the website is the docs, so whenever somebody merges something to main including changes to the docs dir, then it's live 🤷 .

We know this is not optimal and we are working to improve the internal processes to make the docs a first citizen, and issues like this one will help us for sure in improving it.

[leg100]

This has tripped me up as well (The docs say you can use TESTCONTAINERS_RYUK_DISABLED=true to disable the reaper but support for this was only added after the latest tagged release and thus is not available when one installs your lib using @latest.

I noticed you're using Material for MkDocs. There is a simple solution to having the website show the latest tagged version by default and not main:

https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/