apache / gravitino

World's most powerful open data catalog for building a high-performance, geo-distributed and federated metadata lake.
https://gravitino.apache.org
Apache License 2.0
1.1k stars 348 forks source link

[Improvement] We should have a full version list for documents #5108

Open JunpingDu opened 1 month ago

JunpingDu commented 1 month ago

What would you like to be improved?

Our project's documentation is version specific which is a general case for all open source projects. For users who want to quickly access the specific version of document, there should be a place. Take Apache Spark for example: https://spark.apache.org/documentation.html, you can find historic versions of documents there. In our case (gravitino), the document link (https://gravitino.apache.org/docs/) will directly go to latest version. I think we should have a full list there, given 0.6.1 is quickly out.

How should we improve?

As I mentioned above, we should have a full version list of documents that can route to specific version.

mchades commented 1 month ago

we already have the version list in the top left corner of the page, do we still need a separate page to list the historical versions?

image
JunpingDu commented 1 month ago

It may not be enough - the users who click docs on website may not aware which version they are current using/deploying, so go directly to latest version may confuse them. Also, we should define "current" & "latest" version in url later - for some project like hadoop, "latest" means the largest number we have, "current" means the latest stable version. i.e. assume we release in a sequence of 0.6.1 (stable), 0.7.0 (alpha), 0.6.2(stable). When 0.7.0 comes out, the current is still 0.6.1 as 0.7.0 is not stable. Also, although 0.6.2 is released after 0.7.0, then latest is still "0.7.0" when 0.6.2 is out. I am not saying we have to follow Hadoop or some other project, but we do need to have a guideline for users who choose versions seriously for production case. Have an additional doc page or somewhere else to let users easy to find this information seems important to me.