Where can users view the field 'description'? [SOLVED]


#1

Hey guys, I want to help my users finding the right data and using it correctly, so I’d like to add some explanation to most, if not all, columns I’m exposing them to.

I thought going to the data model and adding descriptions to columns there would do the trick, but it appears they don’t show up anywhere on the user side of things. Anyone know if this is correct or am I just looking in the wrong place?

If it doesn’t show up anywhere now, is there an alternative way to add this form of documentation to metabase? If not, I’ll create a feature request.


#2

I think what you’re looking for is this page in the :blue_book: Users Guide:

Let us know if that solves it for you? :slight_smile:


#3

Thanks @jornh! So I can only see the field descriptions in the sidebar data reference, not by using the ‘data reference’ menu option. Unfortunately the side bar data reference is kind of useless for us, as we’ve also linked to bigquery which has a table for every day of analytics… so the ‘real’ data is kind off swamped under like 1500 other tables, as the sidebar doesn’t filter to only show the database you’re currently using in your question.


#4

I feel your pain here as well. A nice enhancement IMO would consist of two things:

  1. Let the sidebar data reference be synchronized to the actual table you’re building your question on.
  2. Also have the same info available in the full page data reference. (pretty sure it’s a developer oversight)

#5

Yes, both of these would greatly improve usefulness of the data reference I think. Would you happen to know if this is logged on github somewhere already?


#6

Hah! just found one related to my number 2. above: https://github.com/metabase/metabase/issues/6316 (the Data Ref & Getting Started label is really useful - after you searched for “Data Reference” in issues).

Turn’s out it is actually in the full Data Reference … it’s just that it’s so deeply, deeply nested in the navigation that you have a hard time to find it - just for looking at it - an example URL might be http://localhost:3000/reference/databases/1/tables/2/fields/9.

So that one is already covered. Just voted for it/commented there as well.

Don’t know maybe the https://github.com/metabase/metabase/issues/6585 is what comes closest to my number 1. above? Sorry, I couldn’t upvote that one - since it turns out I already did so a while ago :rofl:


#7

Thanks jornh! I also logged https://github.com/metabase/metabase/issues/8307 as a proposal for how to filter the data ref sidebar :slight_smile: