search

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
10.15k stars 2.93k forks source link

Adding documentation to the data shown in the Web UI #14903

Open tangjiangling opened 1 year ago

tangjiangling commented 1 year ago

Recently, I've been seeing questions in slack about the meaning of data on the Web UI, such as:

We don't seem to have documentation for this at the moment, so to make life easier, it's time to add it.

The overall Web UI consists of 3 parts:

Although it seems to be only 3 parts, it is a long process if you want to make webui fully documented. So, let's come along and see it happen.

tangjiangling commented 1 year ago

CC: @mosabua

hashhar commented 1 year ago

Is the goal to add tooltip/detail to the UI itself or to document it in the docs? I think the former approach is more discoverable for users but maybe requires a bit more work?

I don't have a very strong opinion though.

tangjiangling commented 1 year ago

Is the goal to add tooltip/detail to the UI itself or to document it in the docs?

The goal is to answer the question: when a user is confused about the data shown in the web UI, there is a place to find explanations (either in the form of a document or a tooltip in the UI)

I think the former approach is more discoverable for users but maybe requires a bit more work?

Agreed (You have inspired me, I only thought of the document form before you replied)

mosabua commented 1 year ago

The best place to check for information about the web ui is Trino: The Definitive Guide. I wrote a lot of it up there and you can get a copy easily from Starburst. The information in there could be moved to the documentation, which is currently very minimal - https://trino.io/docs/current/admin/web-interface.html

That same info can also be added to the UI as tool tips ..

Free free to work on either approach and send PRs. Given that there is a lot of stuff I would suggest to keep it small and submit it in a sequence of manageable chunks for reviewers..

hashhar commented 1 year ago

cc: @electrum for his opinion on a preferred direction.