Documentation: Versioning?

[matrey]

Describe the feature

I was looking at https://valkey.io/valkey-glide/python/base_batch/
But then trying on local, I got error: Module "glide" has no attribute "Batch"
Turns out the batch feature only got merged to main 2 weeks ago #3555 (comment) and is therefore not present in the current latest release 1.3.5

It would be good to clarify that the documentation site is for main, and might therefore reference upcoming features

And maybe think about how to have a version of the documentation site matching the latest release

Use Case

Proposed Solution

No response

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

Client version used

1.3.5

Environment details (OS name and version, etc.)

N/A

[avifenesh]

@matrey yes, apologize, we need to make sure we release the docs with the release and not with main, at least.

Thanks!

@liorsve @eifrah-aws

[ikolomi]

@eifrah-aws
We need to either allow selecting the docs version here: https://valkey.io/valkey-glide/
Or publish docs for the latest released version (The first approach is preferable)

Can you handle it?

[eifrah-aws]

@liorsve ^^

[liorsve]

As an immediate solution, I merged #3913 (and #3972) that allows for the website to be built & deployed only from release branches, and only by manual workflow dispatch, so we'll have full control over the site content.
Specifically in the current case of the Transaction/Batch classes docs, it it a bit problematic to revert the docs site to the way it was before they were put in, because the transaction functions+docs were removed from main (and from release-2.0), but at the same time the release-1.3 branch doesn't have the website additions at all. So for now, mainly because the release is imminent, we chose to keep it as it is, but to make clear that Batch will be available from version 2.0.0 only. Once 2.0.0 is out I'll remove these notes.

For next steps, we should consider using a versioning tool like mike to allow for different versions to be displayed. I started but it requires some more work.