trinodb / trino

Official repository of Trino, the distributed SQL query engine for big data, formerly known as PrestoSQL (https://trino.io)
https://trino.io
Apache License 2.0
9.88k stars 2.86k forks source link

[Multi-Versioned Docs] Add Version Dropdown to Trino Docs #13205

Open kevinjqliu opened 1 year ago

kevinjqliu commented 1 year ago

Problem

I want to see the documentation for older versions of Trino, not just the latest.

Trino docs defaults to the latest release. Given the speed of Trino releases, I am most often not running on the latest version and I’m not sure if the feature I want to use is available in my version. There is the "release notes" section to see when the new feature was released. But, I have to parse through the release diffs.

Ask

It would be great to have a way to “time travel” on documentation. I would like to view the v358 version of the documentation.

As part of researching this, it seems like the v358 docs are available in the production website. (https://trino.io/docs/358/). So adding a version dropdown to navigate the older version docs should help with this use-case.

Example

Iceberg docs (https://iceberg.apache.org/) make available older versions.

Screen Shot 2022-07-17 at 10 52 03 AM
findepi commented 1 year ago

I think @mosabua added a version switcher in Starburst docs https://docs.starburst.io/latest/ so will best know what it takes to add one in Trino docs.

mosabua commented 1 year ago

Our framework for the docs easily supports this. However there are a few issues with this approach:

As such I suggest NOT to add a version drop down.

We could add some information on a page somewhere that explains that all docs are available at the version path but I am not even sure we should do that. For reference the gh pages source repo for all docs is at https://github.com/trinodb/docs.trino.io

Or maybe we could just add the last 5 releases or so .. but even then I am not sure there is much value