diff --git a/docs/administration-guide/01-managing-databases.md b/docs/administration-guide/01-managing-databases.md index 34a25b2035e0fd39da0aba6d9c33d0efafe0180c..acea451c050a978256fb74898dede4bf81415883 100644 --- a/docs/administration-guide/01-managing-databases.md +++ b/docs/administration-guide/01-managing-databases.md @@ -1,10 +1,10 @@ ## Managing Databases -If you already connected your database during the installation, you’ve probably a covered a lot of this info. But if you need to add another database or manage the settings of the one you already have connected, just click the circle with your initials in the top right of Metabase and select the **Admin Panel**. +If you already connected your database during the installation, you’ve probably a covered a lot of this territory. But if you need to add another database or manage the settings of one you've already have connected, just click the settings icon in the top right of Metabase and select **Admin**.  -Cool, now you’re in the admin panel. Next, select **Databases** from the menu bar at the top of the screen to see your databases. +Cool, now you’re in the administration section of Metabase. Next, select **Databases** from the menu bar at the top of the screen to see your databases. ### Adding a Database Connection diff --git a/docs/administration-guide/04-managing-users.md b/docs/administration-guide/04-managing-users.md index 013985fe52d4f00ab24995b9e68e291c09aeb668..b2814d8e57f8f07a21666063bcad4f76e2875b33 100644 --- a/docs/administration-guide/04-managing-users.md +++ b/docs/administration-guide/04-managing-users.md @@ -1,6 +1,6 @@ ## Managing User Accounts -To start managing users, first go to the **Admin Panel** by clicking on the dropdown menu in the top right of Metabase and selecting Admin Panel. +To start managing users, first go to the **Metabase Admin** section by clicking on the dropdown menu in the top right of Metabase and selecting Admin.  @@ -13,11 +13,13 @@ To add a new user account, click **Add person** in the upper right corner. You If you’ve already [configured Metabase to use email](02-setting-up-email.md), Metabase will send the new user an invite email. Otherwise, it’ll give you a temporary password that you’ll have to send to the person you’re inviting by hand. -### Removing a user -To delete a user's account, click on the three dots icon on the right of a user’s row and select **Remove** from the dropdown. Deleting an account will mark it as inactive and prevent it from being used in the future - but it *won’t* delete that user's saved questions or dashboards. +### Deactivating a user +To deactivate a user's account, click on the three dots icon on the right of a user’s row and select **Deactivate** from the dropdown. Deactivating an account will mark it as inactive and prevent the user from logging in - but it *won’t* delete that user's saved questions or dashboards.  +To reactivate a deactivated user, click on the Deactivated tab at the top of the list of your users to see the list of inactive users. Click on the icon on the far right to reactivate that user, allowing them to log in to Metabase again. + ### Editing a user You can edit a user’s name and email address by clicking the three dots icon and choosing **Edit Details**. Note: be careful when changing a user’s email address, because *this will change the address they’ll use to log in to Metabase*. @@ -25,9 +27,14 @@ You can edit a user’s name and email address by clicking the three dots icon a A user can always reset their password using the forgot password link on the login screen, but if you want to do this for them, just click the three dots icon and choose Reset Password. If you haven’t configured your email settings yet, you’ll be given a temporary password that you’ll have to share with that user. Otherwise, they’ll receive a password reset email. ### Changing a user’s role -Right now, the only role a user can have is either User or Admin. The only difference is that Admins can access the Admin Panel and make changes there. +Right now, the only special role a user can have is Admin. The only difference is that Admins can access the Admin Panel and make changes there, and can set [permissions on collections](06-collections.md). + +To make a user an admin, click on the Groups dropdown and click the check mark next to the Administrators group. + +### Adding users to Groups +Adding users to groups allow you to assign [data access](05-setting-permissions.md) and [collection permissions](06-collections.md) to them. The next two articles in this guide will teach you how to set those permissions, but to add users to one or more groups, just click the Groups dropdown and click the checkboxes next to the group(s) you want to add the user to. -To change a user’s role, just click on it to open a dropdown and make your selection. +Check out this article for more on [creating and managing user groups](05-setting-permissions.md). --- diff --git a/docs/administration-guide/05-setting-permissions.md b/docs/administration-guide/05-setting-permissions.md index 82662c684e25e0f7815eb0d1ac45329ea9a2d7f1..96d6ac41d744f6d97e80b3b21e2d42a0ed20b2cf 100644 --- a/docs/administration-guide/05-setting-permissions.md +++ b/docs/administration-guide/05-setting-permissions.md @@ -8,6 +8,8 @@ Metabase uses a group-based approach to set permissions and restrictions on your A user can be a member of multiple groups, and if one of the groups they’re in has access to a particular database or table, but another group they’re a member of does not, then they **will** have access to that database. +In addition to setting permissions on your databases and tables, you can also [set access permissions on the collections](06-collections.md) where your dashboards, questions, and pulses are saved. Collection permissions are not set from the Admin section; set them by clicking on the edit/pencil icon in the top-right of the screen when viewing a collection. + ### Groups To view and manage your groups, go to the Admin Panel, click on the People section, and then click on Groups from the side menu. @@ -20,7 +22,10 @@ You’ll notice that you already have two default groups: Administrators and All You’ll also see that you’re a member of the **Administrators** group — that’s why you were able to go to the Admin Panel in the first place. So, to make someone an admin of Metabase you just need to add them to this group. Metabase admins can log into the Admin Panel and make changes there, and they always have unrestricted access to all data that you have in your Metabase instance. So be careful who you add to the Administrator group! -The **All Users** group is another special one. Every Metabase user is always a member of this group, though they can also be a member of as many other groups as you want. We recommend using the All Users group as a way to set default access levels for new Metabase users. If you have [Google single sign-on](10-single-sign-on.md) enabled, new users who join that way will be automatically added to the All Users group. (**Important note:** as we mentioned above, a user is given the *most permissive* setting she has for a given database/schema/table across *all* groups she is in. Because of that, it is important that your All Users group should never have *greater* access for an item than a group for which you're trying to restrict access — otherwise the more permissive setting will win out.) +The **All Users** group is another special one. Every Metabase user is always a member of this group, though they can also be a member of as many other groups as you want. We recommend using the All Users group as a way to set default access levels for new Metabase users. If you have [Google single sign-on](10-single-sign-on.md) enabled, new users who join that way will be automatically added to the All Users group. + +#### An important note on the All Users group +As we mentioned above, a user is given the *most permissive* setting she has for a given database/schema/table across *all* groups she is in. Because of that, it is important that your All Users group should never have *greater* access for an item than a group for which you're trying to restrict access — otherwise the more permissive setting will win out. This goes for both data access as well as [collection permission](06-collections.md) settings. If you’ve set up the [Slack integration](09-setting-up-slack.md) and enabled [Metabot](../users-guide/11-metabot.md), you’ll also see a special **Metabot** group, which will allow you to restrict which questions your users will be able to access in Slack via Metabot. diff --git a/docs/administration-guide/06-collections.md b/docs/administration-guide/06-collections.md index 3f8666eb6c741d04fe7686e796e17665d9956d45..6bc85f55058cf3e43e3d30bbddca818676b6c7c8 100644 --- a/docs/administration-guide/06-collections.md +++ b/docs/administration-guide/06-collections.md @@ -1,35 +1,61 @@ ## Creating Collections for Your Saved Questions --- -Collections are a great way to organize your saved questions and decide who gets to see and edit things. Collections could be things like, "Important Metrics," "Marketing KPIs," or "Questions about users." Multiple [user groups](05-setting-permissions.md) can be given access to the same collections, so we don't necessarily recommend naming collections after user groups. + + +Collections are a great way to organize your dashboards, saved questions, and pulses, and to decide who gets to see and edit things. Collections could be things like, "Important Metrics," "Product Team," "Marketing KPIs," or "Questions about users." Collections can even contain other collections, allowing you to create an organizational structure that fits your team. You can also choose which user groups should have what level of access to your collections (more on that below). + +Metabase starts out with a default top-level collection which is called "Our analytics," which every other collection is saved inside of. This page will teach you how to create and manage your collections. For more information on organizing saved questions and using collections, [check out this section of the User's Guide](../users-guide/06-sharing-answers.md). ### Creating and editing collections -Only administrators of Metabase can create and edit collections. From the Questions section of Metabase, click on the `Create a collection` button. Give your collection a name, choose a color for it, and give it a description if you'd like. +If a user has Curate access for a collection, they can create new sub-collections inside it and edit the contents of the collection. From the detail view of any collection, click on the `Create a collection` button to make a new one. Give your collection a name, choose where it should live, and give it a description if you'd like. + + + +By default, new collections will have the same permissions settings as the collection it was created in (its "parent" collection), but you can change those settings from the Edit menu. + +### Pinning things in collections + + +One great feature in Metabase is that you can pin the most important couple of items in each of your collections to the top. Pinning an item in a collection turns it into a big, eye-catching card that will help make sure that folks who are browsing your Metabase instance will always know what's most important. - +Any user with curate permissions for a collection can pin items in it, making it easy to delegate curation responsibilities to other members of your team. To pin something, you can either click and drag it to the top of the page, or click on its menu and choose the pin action. (Note that collections themselves can't be pinned.) ### Setting permissions for collections -Collection permissions are similar to data permissions. Rather than going to the Admin Panel, you set permissions on collections by clicking on the lock icon in the top-right of the Questions screen or the top-right of a collection screen. +Collection permissions are similar to [data access permissions](05-setting-permissions.md). Rather than going to the Admin Panel, you set permissions on collections by clicking on the sharing icon in the top-right of the screen while viewing the collection and clicking on `Edit permissions`. Only Administrators can edit collection permissions. Each [user group](05-setting-permissions.md) can have either View, Curate, or No access to a collection: - +- **View access:** the user can see all the questions, dashboards, and pulses in the collection. If the user does not have permission to view some or all of the questions included in a given dashboard or pulse then those questions will not be visible to them; but any questions that are saved in this collection *will* be visible to them, *even if the user doesn't have access to the underlying data used to in the question.** +- **Curate access:** the user can edit, move, and archive items saved in this collection, and can save or move new items into it. They can also create new sub-collections within this collection. In order to archive a sub-collection within this collection, they'll need to have Curate access for it and any and all collections within it. +- **No access:** the user won't see this collection listed, and doesn't have access to any of the items saved within it. -You'll see a table with your user groups along the top and all your collections down along the left. A user group can have View access, Curate access, or no access to a given collection. + -- View access: can see all the questions in the collection, **even if the user doesn't have access to the underlying data used to create the question.** -- Curate access: can additionally move questions in or out of the collection, and edit the questions in the collection. -- No access: won't see the collection listed on the Questions page, and can't see questions from this collection in dashboards or when creating a Pulse. +If you want to see the bigger picture of what permissions your user groups have for all your collections, just click the link that says `See all collection permissions`. You'll see a table with your user groups along the top and all your collections down along the left. Click the `View collections` link under any collection that contains more collections to zoom in and see its contents: -Just like with data access permissions, collection permissions are *additive*, meaning that if a user belongs to more than one group, if one of their groups has a more restrictive setting for a collection than another one of their groups, they'll be given the *more permissive* setting. This is especially important to remember when dealing with the All Users group: since all users are members of this group, if you give the All Users group Curate access to a collection, then *all* users will be given that access for that collection, even if they also belong to a group with *less* access than that. + -### The "Everything Else" section -If a question isn't saved within a collection, it will be placed in the Everything Else section of the main Questions page. **All your Metabase users can see questions in this section**, provided they have data access permission. +Just like with data access permissions, collection permissions are *additive*, meaning that if a user belongs to more than one group, if one of their groups has a more restrictive setting for a collection than another one of their groups, they'll be given the *more permissive* setting. This is especially important to remember when dealing with the All Users group: since all users are members of this group, if you give the All Users group Curate access to a collection, then *all* users will be given Curate access for that collection, even if they also belong to a group with *less* access than that. + +### Permissions and sub-collections +One nuance with how collections permissions work has to do with sub-collections. A user group can be given access to a collection located somewhere within one more more sub-collections *without* having to have access to every collection "above" it. E.g., if a user group had access to the "Super Secret Collection" that's saved several layers deep within a "Marketing" collection that the group does *not* have access to, the "Super Secret Collection" would show up at the top-most level that the group *does* have access to. + +### Personal collections + + +Each user has a personal collection where they're always allowed to save things, even if they don't have Curate permissions for any other collections. Administrators can see and edit the contents of every user's personal collection (even those belonging to other Administrators) by clicking on the "All personal collections" link from the "Our analytics" collection. + +A personal collection works just like any other collection except that its permissions can't be changed. If a sub-collection within a personal collection is moved to a different collection, it will inherit the permissions of that collection. + + ### Archiving collections -You can archive collections similarly to how you can archive questions. Click the archive icon in the top-right of the collection screen to archive it. This will also archive all questions in the collection, and importantly it will also remove all of those questions from all dashboards and Pulses that use those questions. So be careful! +Users with curate permission for a collection can archive collections. Click the edit icon in the top-right of the collection screen and select `Archive this collection` to archive it. This will also archive all questions, dashboards, pulses, and all other sub-collections and their contents. Importantly, this will also remove any archived questions from all dashboards and Pulses that use them. + +**Note:** the "Our analytics" collection and personal collections can't be archived. -To restore a collection and its contents, click the `View Archive` icon in the top-right of the main Questions screen to see the archive, then hover over an item to reveal the `Unarchive` icon on the far right of the item. Questions within archived collections are not individually listed in the archive, so if you want to unarchive a specific question from an archived collection, you have to unarchive that whole collection. +You can always *unarchive* things by clicking on the More menu from a collection and selecting `View the archive`, then clicking the un-archive button next to an archived item. Questions within archived collections are not individually listed in the archive, so if you want to unarchive a specific question from an archived collection, you have to unarchive that whole collection. ## Next: custom segments and metrics Learn how to define custom segments and commonly referenced metrics in the [next section](07-segments-and-metrics.md). diff --git a/docs/administration-guide/10-single-sign-on.md b/docs/administration-guide/10-single-sign-on.md index 142030502425aab4e4662ea3b7994789adfdb3ba..7ad2edb5730d05b4f2fdf7a72731b19ec3dff1ab 100644 --- a/docs/administration-guide/10-single-sign-on.md +++ b/docs/administration-guide/10-single-sign-on.md @@ -37,13 +37,13 @@ Click the `Configure` button in the LDAP section of the Authentication page, and Click the toggle at the top of the form to enable LDAP, then fill in the form with the information about your LDAP server. -Metabase will pull out three main attributes from your LDAP directory - email (defaulting to the `mail` attribute), first name (defaulting to the `givenName` attribute) and last name (defaulting to the `sn` attribute). If your LDAP setup uses other attributes for these, you can edit this under the "Attributes" portion of the form. +Metabase will pull out three main attributes from your LDAP directory - email (defaulting to the `mail` attribute), first name (defaulting to the `givenName` attribute) and last name (defaulting to the `sn` attribute). If your LDAP setup uses other attributes for these, you can edit this under the "Attributes" portion of the form.  -If you have user groups in Metabase you are using to control access, it is often tedious to have to manually assign a user to a group after they're logged in via SSO. You can take advantage of the groups your LDAP directory uses by enabling Group Mappings, and specifying which LDAP group corresponds to which user group on your Metabase server. +If you have user groups in Metabase you are using to control access, it is often tedious to have to manually assign a user to a group after they're logged in via SSO. You can take advantage of the groups your LDAP directory uses by enabling Group Mappings, and specifying which LDAP group corresponds to which user group on your Metabase server. --- -## Next: Creating a Getting Started Guide -Learn how to easily [make a Getting Started Guide](11-getting-started-guide.md) for your team. +## Next: sharing things with public links +Learn how to create a [publicly accessible link](12-public-links.md) to one of your dashboards or questions. diff --git a/docs/administration-guide/11-getting-started-guide.md b/docs/administration-guide/11-getting-started-guide.md index 1ed5c5fd879a1ee3eec37a0f53b517e09e2ff6d4..e4cbfcf74d2a269ba09bd74dbb85bb1b89fc54e7 100644 --- a/docs/administration-guide/11-getting-started-guide.md +++ b/docs/administration-guide/11-getting-started-guide.md @@ -1,23 +1,3 @@ -## Creating a Getting Started Guide +## Getting Started Guide -In most places we’ve worked, there’s typically an email or a Google doc that that gets forwarded around to new hires that describes how to use the analytics systems available. Some more sophisticated setups use an internal wiki or other website that has an inventory of what’s available. But we believe that the best way to keep information like this current is to have it be documented in the application itself. Metabase now lets you create a cheatsheet to help new users know which dashboards, metrics, and reports are the most important. It also provides a place to document caveats for use, advice on who to contact for help, and more. - -To get started, click on the `Guide` link in the main nav. You'll see a screen like this: - - - -Before you've even created your guide, this page gives you some links that you can use to explore the data you have in Metabase. But for now, click the button to begin making your guide. Now you'll see a list of sections that you can include in your guide: - - - -You can highlight your company's most important dashboard, [metrics](07-segments-and-metrics.md) that you commonly refer to (and the dimensions by which they're most often grouped), and tables and [segments](07-segments-and-metrics.md) that are useful or interesting. There's also a place to write a little bit more about "gotchas" or caveats with your data that your users should know about before they start exploring things and drawing conclusions. Lastly, you can optionally include an email address for your users to contact in case they're still confused about things. - -If you click on a section, it'll expand and let you select the items that you want to include in that section: - - - -To remove an item you've added, just click the X icon in the top-right of the item. When you're all done adding things to your guide, click the `Save` button in the blue bar at the top of the screen. To make edits to your guide, simply click the `Edit` link in the top-right of the guide. Once you click `Save`, you'll see your brand new Getting Started Guide! - - - -Clicking on the title of an item you've included in your guide will take you to the item itself. Clicking on `Learn more` will take you to a more detailed entry about that item so you can explore it and related items in more detail. +The Getting Started Guide was removed from Metabase in version 0.30. Instead, a great way of helping your teammates find their way around Metabase is by pinning the most important dashboards or questions in each of your collections to make it clear what's most important. diff --git a/docs/administration-guide/images/ProfileDropdown.png b/docs/administration-guide/images/ProfileDropdown.png index fff0346f64e1494bff894a91bbe4dd08a022c24d..0ee4f72d9c5c5e43ab6660cf3dcf174af0d9dc7b 100644 Binary files a/docs/administration-guide/images/ProfileDropdown.png and b/docs/administration-guide/images/ProfileDropdown.png differ diff --git a/docs/administration-guide/images/RemoveUser.png b/docs/administration-guide/images/RemoveUser.png index c453c5138d22a138a1bcdfeee91d5742c5371c4b..89eafb83b49c496f29464cd03512f88c7b6ce786 100644 Binary files a/docs/administration-guide/images/RemoveUser.png and b/docs/administration-guide/images/RemoveUser.png differ diff --git a/docs/administration-guide/images/collections/collection-detail.png b/docs/administration-guide/images/collections/collection-detail.png new file mode 100644 index 0000000000000000000000000000000000000000..5dd7fe9277762c16d3f42b6ee64c0a576450f582 Binary files /dev/null and b/docs/administration-guide/images/collections/collection-detail.png differ diff --git a/docs/administration-guide/images/collections/collection-permissions.png b/docs/administration-guide/images/collections/collection-permissions.png new file mode 100644 index 0000000000000000000000000000000000000000..f03d4b6c657825ee58fa43d50bf96fcece2929b3 Binary files /dev/null and b/docs/administration-guide/images/collections/collection-permissions.png differ diff --git a/docs/administration-guide/images/collections/collections-empty-state.png b/docs/administration-guide/images/collections/collections-empty-state.png deleted file mode 100644 index 6fb4d376bdd11cfb577c1d1749f05328a1f11384..0000000000000000000000000000000000000000 Binary files a/docs/administration-guide/images/collections/collections-empty-state.png and /dev/null differ diff --git a/docs/administration-guide/images/collections/create-collection.png b/docs/administration-guide/images/collections/create-collection.png new file mode 100644 index 0000000000000000000000000000000000000000..390c573dad3099930c690339d510542a923d8f9a Binary files /dev/null and b/docs/administration-guide/images/collections/create-collection.png differ diff --git a/docs/administration-guide/images/collections/permission-grid.png b/docs/administration-guide/images/collections/permission-grid.png index f8190d72b12f4bf51429852b28ac61173b7de6e7..673084902d24b20f129ac32c1118bae5f0f45d2f 100644 Binary files a/docs/administration-guide/images/collections/permission-grid.png and b/docs/administration-guide/images/collections/permission-grid.png differ diff --git a/docs/administration-guide/images/collections/personal-collection-detail.png b/docs/administration-guide/images/collections/personal-collection-detail.png new file mode 100644 index 0000000000000000000000000000000000000000..a167776a850a4b814a772f7d315ff758879ff295 Binary files /dev/null and b/docs/administration-guide/images/collections/personal-collection-detail.png differ diff --git a/docs/administration-guide/images/collections/personal-collections.png b/docs/administration-guide/images/collections/personal-collections.png new file mode 100644 index 0000000000000000000000000000000000000000..bd557deaa6a1ff9c2e4e142c5f6a4e93d8785b16 Binary files /dev/null and b/docs/administration-guide/images/collections/personal-collections.png differ diff --git a/docs/administration-guide/images/collections/pinned-items.png b/docs/administration-guide/images/collections/pinned-items.png new file mode 100644 index 0000000000000000000000000000000000000000..0453c64cb496530ad7ade11c241f4d49e772f5a8 Binary files /dev/null and b/docs/administration-guide/images/collections/pinned-items.png differ diff --git a/docs/administration-guide/start.md b/docs/administration-guide/start.md index 2b027253f98e04fc76caed65ea549c3f8068090e..b63fb410d1bedbc9ec1abaacb5143c89968a2956 100644 --- a/docs/administration-guide/start.md +++ b/docs/administration-guide/start.md @@ -14,7 +14,6 @@ Are you in charge of managing Metabase for your organization? Then you're in the * [Configuring settings](08-configuration-settings.md) * [Setting up Slack integration](09-setting-up-slack.md) * [Authenticating with Google Sign-In or LDAP](10-single-sign-on.md) -* [Creating a Getting Started Guide for your team](11-getting-started-guide.md) * [Sharing dashboards and questions with public links](12-public-links.md) * [Embedding Metabase in other Applications](13-embedding.md) * [Caching query results](14-caching.md) diff --git a/docs/users-guide/01-what-is-metabase.md b/docs/users-guide/01-what-is-metabase.md index 3ba08779f728debc9032303b9caaa07940166c0f..1ed4cc455ccc0e06349abd3771c3ab02793a716c 100644 --- a/docs/users-guide/01-what-is-metabase.md +++ b/docs/users-guide/01-what-is-metabase.md @@ -1,6 +1,54 @@ ## What is Metabase? -Metabase is an open source business intelligence tool. It lets you ask questions about your data and displays answers in formats that make sense, whether that's a bar graph or a detailed table. -Your questions can be saved for later, making it easy to come back to them, or you can group questions into great looking dashboards. Metabase also makes it easy to share questions and dashboards with the rest of your team. +Metabase is an open source business intelligence tool. It lets you ask questions about your data, and displays answers in formats that make sense, whether that's a bar graph or a detailed table. + +Your questions can be saved for later, making it easy to come back to them, or you can group questions into great looking dashboards. Metabase also makes it easy to share questions and dashboards with the rest of your team. + +## Finding your way around + +So, you've [gotten Metabase up and running](../operations-guide/start.md) and [connected it to your data](../administration-guide/01-managing-databases.md). It's time to give you the lay of the land. + +### The home page + + + +Fresh out of the box, Metabase will show you a few things on the home page: +* Some [automatic explorations](14-x-rays.md) of your tables that you can look at and save as a dashboard if you like any of them. +* An area where things you or your teammates create will show up, along with a link to see all the dashboards, questions, and pulses you have. +* A list of the databases you've connected to Metabase. + + + +Once you've created some [dashboards](07-dashboards.md), any of them that you pin will show up on the homepage for all of your teammates, so that when they log in to Metabase they'll know right where to go. + +### Browse your data + + + +If you connected your database to Metabase during setup, you'll see it listed at the bottom of the homepage along with the sample dataset that Metabase comes with. Click on a database to see its contents. You can click on a table to see its rows, or you can also click on the bolt icon to x-ray a table and see an automatic exploration of it, or click on the book icon to go to the data reference view for that table to learn more about it. + +### Explore your analytics + +As you and your team create dashboards and collections, they'll start to show up on the homepage. Click on a collection in the "Our analytics" section to see its contents, or click "browse all items" to see everything you and your team have made. [More about exploring](03-basic-exploration.md) + +### Ask a question or write a query + +Click the `Ask a question button` in the top-right of Metabase to start a new custom exploration of one of your tables, or to write a new SQL or native query if you want to really dig in. + +### Make a new dashboard or pulse + +In Metabase, dashboards are made up of saved questions that you can arrange and resize as you please. They're a great way to track important metrics and stats that you care about. Pulses are what regularly scheduled reports are called in Metabase. They can be sent out either via email, Slack, or both. + +To make a dashboard or pulse, click the plus (+) icon in the top-right of the main navigation bar. + + + +### Use search to quickly find things + + + +The search bar that's always present at the top of the screen lets you search through your dashboards, collections, saved questions, and pulses in an instant. Just type part of the title of the thing you're looking for and hit enter. + +## A primer on databases To fully understand how to use Metabase, it’s useful to have at least a high-level understanding of databases, so we'll discuss [the basics of databases](02-database-basics.md) next. diff --git a/docs/users-guide/03-basic-exploration.md b/docs/users-guide/03-basic-exploration.md index 47da7d701aed58a3e6b61fe0a91a6c66a70f343d..b2df4bb89ded93acb94569e40f6cf0ccd4c87508 100644 --- a/docs/users-guide/03-basic-exploration.md +++ b/docs/users-guide/03-basic-exploration.md @@ -1,30 +1,44 @@ ### Exploring in Metabase -As long as you're not the very first user in your team's Metabase, the easiest way to start exploring your data is by looking at dashboards, charts, and lists that your teammates have already created. + +#### See what your teammates have made +As long as you're not the very first user in your team's Metabase, the easiest way to start exploring your data is by looking at dashboards, charts, and lists that your teammates have already created. The best place to start is by checking out any dashboards that might be pinned on your home page or in the collections you have access to. + +#### Browse your data +Alternatively, you can dive right in to exploring the data in Metabase by clicking on one of the databases at the bottom of the home page, and then clicking on a table to see it. You can also click on the bolt icon on any table to see an automatic exploration of its data. Give it a try! + + + +#### Exploring collections +Collections in Metabase are a lot like folders. They're where all your team's dashboards and charts are kept. To explore a collection just click on one in the "Our analytics" section of the home page, or click on `Browse all items` to see everything. + + + +If your teammates are cool, they'll have pinned some important dashboards or questions within your collections; if so, those important or useful items will show up nice and large at the top of a collection. Collections also have a list of any other items that are saved within them, as well as a list of other collections that are saved inside the current one. #### Exploring dashboards -Click on the `Dashboards` nav item to see all the dashboards your teammates have created. Dashboards are simply collections of charts and numbers that you want to be able to refer back to regularly. (You can learn more about dashboards [here](07-dashboards.md)) +Dashboards are simply collections of charts and numbers that you want to be able to refer back to regularly. You can learn more about dashboards [here](07-dashboards.md). -If you click on a part of a chart, such as a bar in a bar chart, or a dot on a line chart, you'll see a menu with actions you can take to dive deeper into that result, or to branch off from it in a different direction. +If you click on a part of a chart, such as a bar in a bar chart, or a dot on a line chart, you'll see a menu with actions you can take to dive deeper into that result, to branch off from it in a different direction, or to [x-ray](14-x-rays.md) it to see an automatic exploration the thing you clicked on.  In this example of pie orders by type over time, clicking on a dot on this line chart gives us the ability to: -- Zoom in — i.e., see just the banana cream pie orders in June 2017 over time -- View these Orders — which lets us see a list of banana cream pie orders in June 2017 -- Break out by a category — this lets us do things like see the banana cream pie orders in June 2017 broken out by the status of the customer (e.g., `new` or `VIP`, etc.) or other different aspects of the order. Different charts will have different break out options, such as Location and Time. +- **Zoom in** — i.e., see just the banana cream pie orders in June 2017 over time +- **View these Orders** — which lets us see a list of banana cream pie orders in June 2017 +- **Break out by a category** — this lets us do things like see the banana cream pie orders in June 2017 broken out by the status of the customer (e.g., `new` or `VIP`, etc.) or other different aspects of the order. Different charts will have different break out options, such as Location and Time. + +**Note that charts created with SQL don't currently have these action options.** Other charts as well as table cells will often also allow you to go to a filtered view of that chart or table. You can click on one of the inequality symbols to see that chart where, for example, the value of the Subtotal column is less than $100, or where the Purchased-at timestamp is greater than (i.e., after) April 1, 2017.  -Lastly, clicking on the ID of an item in table gives you the option to go to a detail view for that single record. (E.g., you can click on a customer's ID to see the profile view for that one customer.) - -**Note that charts created with SQL don't currently have these action options.** +Lastly, clicking on the ID of an item in a table gives you the option to go to a detail view for that single record. (E.g., you can click on a customer's ID to see the profile view for that one customer.) #### Exploring saved questions -In Metabase parlance, every chart or number on a dashboard is called a "question." Clicking on the title of a question on a dashboard will take you to a detail view of that question. You'll also end up at this detail view if you use one of the actions mentioned above. You can also browse all the questions your teammates have saved by clicking the `Questions` link in the main navigation. +In Metabase parlance, every chart or number on a dashboard is called a "question." Clicking on the title of a question on a dashboard will take you to a detail view of that question. You'll also end up at this detail view if you use one of the actions mentioned above. -When you're viewing the detail view of a question, you can use all the same actions mentioned above. You can also click on the headings of tables to see more options, like viewing the sum of the values in a column, or finding the minimum or maximum value in it. +When you're looking at the detail view of a question, you can use all the same actions mentioned above. You can also click on the headings of tables to see more options, like viewing the sum of the values in a column, or finding the minimum or maximum value in it.  @@ -33,15 +47,17 @@ Additionally, the question detail page has an Explore button in the bottom-right  Here's a list of all the actions: -* Table actions +* **Table actions** + - `X-ray this` will show you an automatic exploration and summary of the data in this table. [Learn more about x-rays](14-x-rays.md) - `Count of rows by time` lets you see how many rows there were in this table over time. - `Summarize this segment` gives you options of various summarization functions (sum, average, maximum, etc.) you can use on this table to arrive at a number. -* Chart and pivot table actions +* **Chart and pivot table actions** - `Break outs` will be listed depending on the question, and include the option to break out by a category, location, or time. For example, if you're looking at the count of total orders over time, you might be able to further break that out by customer gender, if that information is present. - `View this as a table` does what it says. Every chart has a table behind it that is providing the data for the chart, and this action lets you see that table. - `View the underlying records` shows you the un-summarized list of records underlying the chart or number you're currently viewing. + - `X-ray this question` will show you an automatic [x-ray]((14-x-rays.md)) exploration of this question's results. --- -## Next: Asking new questions +## Next: Asking custom questions So what do you do if you can't find an existing dashboard or question that's exactly what you're looking for? Let's learn about [asking our own new questions](04-asking-questions.md) diff --git a/docs/users-guide/04-asking-questions.md b/docs/users-guide/04-asking-questions.md index 509b4c846b8fc1eef926a7f41d24ee9a45eeeda5..1989b06a1f67896a3fd28b606ddde3babd8ab53d 100644 --- a/docs/users-guide/04-asking-questions.md +++ b/docs/users-guide/04-asking-questions.md @@ -1,21 +1,20 @@ -## Asking questions +## Asking custom questions --- Metabase's two core concepts are questions and their corresponding answers. Everything else is based around questions and answers. To ask Metabase a question, click the New Question button at the top of the screen. ### Ways to start a new question -If an administrator has [defined some metrics or segments](../administration-guide/07-segments-and-metrics.md), when you click on the New Question button, you'll see a screen like this one: +If an administrator has [defined some metrics](../administration-guide/07-segments-and-metrics.md), when you click on the `Ask a question` button in the top bar you'll see a screen like this one:  You can start your new question: - from an existing metric -- from an existing segment - from scratch with the Question Builder interface -- or using the SQL / native query editor +- using the SQL / native query editor -Asking a new question about a **metric** or a **segment** is often a great place to start. +Asking a new question about a **metric** is often a great place to start. #### Asking a new question about a metric @@ -31,25 +30,23 @@ You can also use the Action Menu in the bottom-right of the screen to choose a b  -#### Asking a new question about a segment +#### Asking a new question about a table -A **segment** is any kind of list or table of things that your company cares about: returning users, orders that used a certain promo code, or sales leads that need to be followed up with are all examples of possible segments. +Another quick way to start a new question is by clicking on one of your connected databases at the bottom of the homepage, and picking a table that you have a question about. You'll immediately see the table and the graphical question builder so that you can keep exploring. -Selecting the Segment option from the new question menu will show you a list of your company's segments. When you click on one, you'll see a list, like this one: + - - -When viewing a segment or a table, you can click on the headings of columns to see options for ways to explore more, like seeing the distribution of the values a column has, or the number of distinct values: +When viewing a table you can also click on the headings of columns to see options for ways to explore more, like clicking on the Age column of your Users table to see how many Users you have per age group (that's called a "distribution"):  -You can also use the Action Menu when viewing a segment or table to see any metrics that are related, or to summarize the table. +You can also use the Action Menu when viewing a table to see any metrics in it, or to summarize the table.  #### Asking a new custom question -If your team hasn't set up any metrics or segments, or if you have a question that isn't covered by an existing question or segment, you can create a custom question using the Question Builder interface by clicking "Custom." Or, if you're an advanced user, you can click "SQL" to go straight to the SQL/native query editor. +If you have a question that isn't covered by an existing question, you can create a new custom question using the Question Builder interface by clicking "Custom." Or, if you're an advanced user, you can click "SQL" to go straight to the SQL/native query editor. ### Using the Question Builder interface @@ -61,7 +58,7 @@ Metabase has a simple graphical question builder that looks like this: The question builder is made up of four distinct sections, from left to right: - **Data**, where you pick the source data you want to ask a question about - **Filters**, where you can optionally add one or more filters to narrow down your source data -- **View**, where you choose what you want to see — raw table data, a basic metric, or a saved metric +- **View**, where you choose what you want to see — raw table data, a basic metric, or a "common" metric that an administrator has defined - **Groupings**, where you can group or break out your metric by time, location, or other categories #### Source data @@ -86,7 +83,7 @@ You can use most saved questions as source data, provided you have [permission]( #### Filters --- -Filtering your data lets you exclude information that you don’t want. You can filter by any field in the table you're working with, or by any tables that are connected through a foreign key. Filters narrow down the source data to an interesting subset, like "active users" or "bookings after June 15th, 2015." +Filtering your data lets you exclude information that you don’t want. You can filter by any field in the table you're working with, or by any tables that are connected through a foreign key. Filters narrow down the source data to an interesting subset, like "active users" or "bookings after June 15th, 2015." Different fields will have different filter options based on what kind of data type they are. There are four universal filter options, or “operators,†that can be applied to any field. These operators are: @@ -105,27 +102,25 @@ Fields that are comparable, like numbers or dates, can also be filtered using th ##### Filtering by dates -If filtering by dates, a date picker will appear to allow you to select dates easily. You have two main options for picking your date: relative or specific. +If filtering by dates, a date picker will appear to allow you to select dates easily, and will default to the previous 30 days. -**Specific Dates** -This is the most basic way to select dates. You just click on the date you want from the calendar. If you click on a second date, the picker will select all the dates in between the two you clicked on, creating a range. Clicking on any date while you have a range selected will clear the range. You can also use the **All before** and **All after** buttons to quickly select all dates before or after the one you’ve selected. +Click on the first dropdown to change the kind of date filter you're using. The rest of the popup menu will change depending on this first selection. -**Relative Dates** -Relative dates are how we more commonly talk about time: “how many customers did we have **last month**?†We talk about time relative to today. +One important thing to understand when filtering by time or dates like this is the difference between specific and relative dates: -In practice, if you select **Past 30 days** from the Relative Date calendar picker, this would be the same as selecting those same dates from the Specific Date picker — *unless* you save your question and look at it again tomorrow. +**Specific dates** are things like November 1, 2010, or June 3 – July 12, 2017; they always refer to the same date(s). -Now the relative date will be referencing the past 30 days from *today*, *not* from the day you saved the question. This is a really useful way of creating and saving questions that stay up-to-date: you can always know what your total sales were in the past 7 days, for example. +**Relative dates** are things like "the past 30 days," or "the current week;" as time passes, the dates these refer to change. Relative dates are a useful way to set up a filter on a question so that it stays up to date by showing you for example how many users visited your website in the last 7 days. ##### Using segments -If your Metabase admins have created special named filters, called segments, for the table you’re viewing, they’ll appear at the top of the filter dropdown in purple text with a star next to them. These are shortcuts to sets of filters that are commonly used in your organization. They might be something like “Active Users,†or “Most Popular Products.†+If your Metabase administrators have created special named filters for the table you're viewing they’ll appear at the top of the filter dropdown in purple text with a star next to them. These are called "segments," and they're shortcuts to filters that are commonly used in your organization. They might be called things like “Active Users,†or “Most Popular Products.†#### Selecting answer output in the View section --- The next section of the question builder is where you select what you want the output of your answer to be, under the View dropdown. You’re basically telling Metabase, “I want to view…†Metabase can output the answer to your question in four different ways: ##### 1. Raw data -Raw Data is just a table with the answer listed in rows. It's useful when you want to see the actual data you're working with, rather than a sum or average, etc., or when you're exploring a small table with a limited number of records. +Raw Data is just a table with the answer listed in rows. It's useful when you want to see the actual data you're working with, rather than a sum or average, etc., or when you're exploring a small table with a limited number of records. When you filter your data to see groups of interesting users, orders, etc., Raw Data will show you an output of each individual record that matches your question's criteria. diff --git a/docs/users-guide/05-visualizing-results.md b/docs/users-guide/05-visualizing-results.md index a9189aa701ef190d6e66824e9cab496346baf500..ffaac59c495404d59f8967bca093e08ce5cd5f2a 100644 --- a/docs/users-guide/05-visualizing-results.md +++ b/docs/users-guide/05-visualizing-results.md @@ -39,7 +39,32 @@ Progress bars are for comparing a single number result to a goal value that you  #### Tables -The Table option is good for looking at tabular data (duh), or for lists of things like users. The options allow you to hide and rearrange fields in the table you're looking at. If your table is a result that contains one metric and two dimensions, Metabase will also automatically pivot your table, like in the example below (the example shows the count of orders grouped by the review rating for that order and the category of the product that was purchased; you can tell it's pivoted because the grouping field values are all in the first column and first row). You can turn this behavior off in the chart settings. +The Table option is good for looking at tabular data (duh), or for lists of things like users or orders. The visualization options for tables allow you to add, hide, or rearrange fields in the table you're looking at. + +##### Adding or hiding fields + + + +Open up the visualization options and you'll see the Data tab, which displays all the fields currently being shown in the table, as well as more fields from linked tables that you can add to the current table view. + +To hide a field, click the X icon on it; that'll send it down to the "More fields" area in case you want to bring it back. To add a linked field, just click the + icon on it, which will bring it to the "Visible fields" section. Click and drag any of the fields listed there to rearrange the order in which they appear. + +**Note:** changing these options doesn't change the actual table itself; it just creates a custom view of it that you can save as a "question" in Metabase and refer back to later, share with others, or add to a dashboard. + +##### Conditional formatting +Sometimes is helpful to highlight certain rows or columns in your tables when they meet a specific condition. You can set up conditional formatting rules by going to the visualization settings while looking at any table, then clicking on the `Formatting` tab. + + + +When you add a new rule, you'll first need to pick which column(s) should be affected. For now, you can only pick numeric columns. Your columns can be formatted in one of two ways: + +1. **Single color:** pick this if you want to highlight cells in the column if they're greater, less than, or equal to a specific number. You can optionally highlight the whole row of a cell that matches the condition you pick so that it's easier to spot as you scroll down your table. +2. **Color range:** choose this option if you want to tint all the cells in the column from smallest to largest or vice a versa. + +You can set as many rules on a table as you want. If two or more rules disagree with each other, the rule that's on the top of your list of rules will win. You can click and drag your rules to reorder them, and click on a rule to edit it. + +##### Pivoted tables +If your table is a result that contains one metric and two dimensions, Metabase will also automatically "pivot" your table, like in the example below (the example shows the count of orders grouped by the review rating for that order and the category of the product that was purchased; you can tell it's pivoted because the grouping field values are all in the first column and first row). You can turn this behavior off in the chart settings.  diff --git a/docs/users-guide/06-sharing-answers.md b/docs/users-guide/06-sharing-answers.md index 7c80b05099b877fbc3263c1317bdf5283859ce50..c293c56f5bbf3234049a969903a518b6fbe9609b 100644 --- a/docs/users-guide/06-sharing-answers.md +++ b/docs/users-guide/06-sharing-answers.md @@ -1,15 +1,15 @@ -## Sharing your questions and answers +## Sharing and organizing your questions and answers --- ### How to save a question Whenever you’ve arrived at an answer that you want to save for later, click the **SAVE** button in the top right of the screen. This will also save the visualization option you’ve chosen for your answer. - + -A pop-up box will appear, you to give your question a name and a description. We suggest phrasing the names for your questions in the form of a question, such as, “How many customers did we have last month?†After saving your question, you'll be asked if you want to add it to a dashboard. +A pop-up box will appear, prompting you to give your question a name and description, and to pick which collection to save it in. Note that your administrator might have set things up so that you're only allowed to save questions in certain collections, but you can always save things in your Personal Collection. After saving your question, you'll be asked if you want to add it to a new or existing dashboard. -Now, whenever you want to refer to your question again you can find it in the saved questions list by clicking on the **Questions** link from the main navigation. To edit your question, go to it and click the pencil icon in the top-right. +Now, whenever you want to refer to your question again you can find it by searching for it in the search bar at the top of Metabase, or by navigating to the collection where you saved it. To edit your question, go to it and click the pencil icon in the top-right. ### Sharing questions with public links If your Metabase administrator has enabled [public sharing](../administration-guide/12-public-links.md) on a saved question or dashboard, you can go to that question or dashboard and click on the sharing icon to find its public links. Public links can be viewed by anyone, even if they don't have access to Metabase. You can also use the public embedding code to embed your question or dashboard in a simple web page or blog post. @@ -17,34 +17,50 @@ If your Metabase administrator has enabled [public sharing](../administration-gu  ### Organizing and finding your saved questions -After your team has been using Metabase for a while, you’ll probably end up with lots of saved questions. The Questions page has several tools that’ll help you organize things and find what you’re looking for. +After your team has been using Metabase for a while, you’ll probably end up with lots of saved questions. Metabase has several ways to help you organize things and find what you’re looking for. - + #### Collections -Administrators of Metabase can create collections to put saved questions in. Depending on the permissions you've been given to collections, you'll be able to view the questions inside, edit them, and move questions from one collection to another. Questions that aren't saved in any collection will appear in the "Everything else" section of the main Questions page, and are visible to all Metabase users in your organization. If you're an administrator of your Metabase instance, here are [instructions for creating collections and managing permissions](../administration-guide/06-collections.md). +Collections are the main way to organize questions, as well as dashboards and pulses. [Administrators can give you different kinds of access](../administration-guide/06-collections.md) to each collection: -#### Shortcuts -At the top of lists of saved questions you’ll find a dropdown with shortcuts to your favorite questions (mark a question as a favorite by clicking on the star icon that appears when you hover over it), questions you’ve recently viewed, questions that you’ve saved personally, and popular questions that are used the most by your team. +- **View access:** you can see the collection and its contents, but you can't modify anything or put anything new into the collection. +- **Curate access:** you can edit, move, or archive the collection and its contents. You can also move or save new things in it and create new collections inside of it, and can also pin items in the collection to the top of the screen. Only administrators can edit permissions for collections, however. +- **No access:** you can't see the collection or its contents. If you have access to a dashboard, but it contains questions that are saved in a collection you don't have access to, those questions will show a permissions notification instead of the chart or table. -#### Search and filtering -On the main Questions page, you can search through all of your collections for a particular question using the search box in the top-right. You can also filter lists of saved questions by typing in the `Filter the list…` area. +#### Your personal collection +In addition to the collections you and your teammates have made, you'll also always have your own personal collection that only you and administrators can see. To find it, click on the "browse all items" button on the homepage and click on "my personal collection" in the list of collections. -#### Moving -To move a question into a collection, or from one collection to another, hover over it and click on the right-arrow icon that appears on the far right of the question. Note that you have to have permission to edit the collection that you're moving a question into, and the collection you're moving the question out of. +You can use your personal collection as a scratch space to put experiments and explorations that you don't think would be particularly interesting to the rest of your team, or as a work-in-progress space where you can work on things and then move them to a shared place once they're ready. -#### Archiving -Sometimes questions outlive their usefulness and need to be sent to Question Heaven. To archive a question, just click on the box icon that appears on the far right when you hover over a question. Collections can also be archived and unarchived, but only by Metabase administrators. +#### Pinned items + + + +In each collection, you can pin important or useful dashboards or questions to make them stick to the top of the screen. Pinned items will also be displayed as large cards to make them stand out well. If you have Curate permissions for a collection, you can pin and un-pin things, and drag and drop pins to change their order. + +Any dashboards that are pinned in the main "Our analytics" collection will also show up on the homepage. + +#### Search -Note that archiving a question removes it from all dashboards or Pulses where it appears, so be careful! + -If you have second thoughts and want to bring an archived question back, you can see all your archived questions from the **Archive** icon at the top-right of the Questions page. To unarchive a question, hover over it and click the box icon that appears on the far right. +Type into the search box that's at the top of Metabase and hit enter to search through all the dashboards, questions, collections, and pulses your team has. -#### Selecting multiple questions -Clicking on the icon to the left of questions let's you select several at once so that you can move or archive many questions at once. +#### Moving +To move a question, dashboard, or pulse into a collection, or from one collection to another, just click and drag it onto the collection where you want it to go. You can also click on the `…` menu to the right of the question and pick the Move action. If you're trying to move several things at once, click on the items' icons to select them, then click the Move action that pops up at the bottom of the screen.  +Note that you have to have Curate permission for the collection that you're moving a question into *and* the collection you're moving the question out of. + +#### Archiving +Sometimes questions outlive their usefulness and need to be sent to Question Heaven. To archive a question or dashboard, just click on the `…` menu that appears on the far right when you hover over a question and pick the Archive action. You'll only see that option if you have "curate" permission for the current collection. You can also archive multiple items at once, the same way as you move multiple items. Note that archiving a question removes it from all dashboards or Pulses where it appears, so be careful! + +You can also archive *collections* as long as you have curate permissions for the collection you're trying to archive, the collection *it's* inside of, as well as any and all collections inside of *it*. Archiving a collection archives all of its contents as well. + +If you have second thoughts and want to bring an archived item back, you can see all your archived questions from the archive; click the menu icon in the top-right of any collection page to get to the archive. To unarchive a question, hover over it and click the unarchive icon that appears on the far right. + --- ## Next: creating dashboards diff --git a/docs/users-guide/07-dashboards.md b/docs/users-guide/07-dashboards.md index 8008029fd4932acd63b217a72b893b818ca6e4f1..4c1e6ddff48b42abf91c9fab587c0712c6b2d2dc 100644 --- a/docs/users-guide/07-dashboards.md +++ b/docs/users-guide/07-dashboards.md @@ -10,12 +10,12 @@ Have a few key performance indicators that you want to be able to easily check? You can make as many dashboards as you want. Go nuts. ### How to create a dashboard -Once you have a question saved, you can create a dashboard. Click the **Dashboards** link at the top of the screen, then click the plus icon in the top-right to create a new dashboard. Give your new dashboard a name and a description, then click **Create**, and you’ll be taken to your shiny new dashboard. +Click the plus (+) icon in the top-right of the screen to open the menu to create a new dashboard. Give your new dashboard a name and a description, choose which collection it should be saved in, then click **Create**, and you’ll be taken to your shiny new dashboard.  ### Adding saved questions to a dashboard -You can add a newly saved question to a dashboard directly from the window that pops up after you save the question, or by clicking the Add to Dashboard icon in the top-right of a question page. You can also go to one of your dashboards and click the plus icon in the top right to add any of your saved questions to the dashboard. +You can add a newly saved question to a dashboard directly from the window that pops up after you save the question, or by clicking the Add to Dashboard icon in the top-right of a question page. You can also go to one of your dashboards and click the plus icon in the top right to add any of your saved questions to the dashboard. Dashboards and the questions they contain do not need to be saved in the same collection. Once you add a question to your dashboard, it’ll look something like this: @@ -57,14 +57,12 @@ Questions in your dashboard will automatically update their display based on the ### Archiving a dashboard Archiving a dashboard does not archive the individual saved questions on it — it just archives the dashboard. To archive a dashboard while viewing it, click the pencil icon to enter edit mode, then click the Archive button. -You can view all of your archived dashboards by clicking the box icon in the top-right of the Dashboards page. Archived dashboards in this list can be unarchived by clicking the icon of the box with the upward arrow next to that dashboard. - -(Note: as of Metabase v0.24, dashboards can no longer be permanently deleted; only archived.) +You can view all of your archived items by clicking the menu icon in the top-right of any collection page. Archived dashboards in this list can be unarchived by clicking the icon of the box with the upward arrow next to that dashboard. ### Finding dashboards -After a while, your team might have a lot of dashboards. To make it a little easier to find dashboards that you look at often, you can mark a dashboard as a favorite by clicking the star icon on it from the dashboards list. You can use the filter dropdown in the top of the list to view only your favorite dashboards, or only the ones that you created yourself. +After a while, your team might have a lot of dashboards. To make it a little easier to find dashboards that your team looks at often, you can pin them to the top of the collection by clicking and dragging them to the top or by opening the `…` menu and selecting the Pin action. - +You can also search for any dashboard (or question, collection, or pulse) by its title in the big search box at the top of Metabase. ### Fullscreen dashboards diff --git a/docs/users-guide/09-multi-series-charting.md b/docs/users-guide/09-multi-series-charting.md index f626a7d641e247ff534e6490deb208321614a3fb..174839b81ee6258b310bded3fe89dfa1aff7cafa 100644 --- a/docs/users-guide/09-multi-series-charting.md +++ b/docs/users-guide/09-multi-series-charting.md @@ -43,10 +43,8 @@ Once you have your chart looking how you’d like, hit done and your changes wil #### A quick note about SQL based questions. Metabase has less information about SQL based questions, so we cannot guarantee if they can be added reliably. You'll see a little warning sign next to SQL questions to indicate this and when you try adding them just be aware it may not work. -### Combining scalars -If you need to compare flat numbers and get a sense of how they differ, Metabase also lets you turn multiple scalars into a bar chart. To do this, follow the same process outlined above. While editing a dashboard, click “edit data†on the scalar of your choice and then select the other scalars you’d like to see represented on the bar chart. - -At Metabase, we use this to create simple funnel visualizations. +### Combining Number charts +If you need to compare single numbers and get a sense of how they differ, Metabase also lets you turn multiple Number charts into a bar chart. To do this, follow the same process outlined above. While editing a dashboard, click “edit data†on the Number chart of your choice and then select the other saved question(s) you’d like to see represented on the bar chart. (At Metabase, we use this to create simple funnel visualizations.) ### Creating a multi-series visualization in the query builder. If you’re creating a new question in the query builder, you can also view the result as a multi-series visualization. To do this you’ll need to add two dimensions to your question and use an aggregation that isn’t just “raw data.†diff --git a/docs/users-guide/10-pulses.md b/docs/users-guide/10-pulses.md index 511f5cdc65d2b33c24cd41a5c941f2aa8fb00ba2..36612bed79117555c9224f029ba04b015a6fd331 100644 --- a/docs/users-guide/10-pulses.md +++ b/docs/users-guide/10-pulses.md @@ -2,12 +2,10 @@ ## Sharing updates with pulses The Pulses feature in Metabase gives you the ability to automatically send regular updates to your teammates to help everyone keep track of changes to the metrics that matter to you most. You can deliver a pulse via email or [Slack](https://slack.com/), on the schedule of your choice. -Click the `Pulses` link in the top menu to view all of your pulses, and click `Create a pulse` to make a new one. - - +To create a new pulse, click the plus (+) button in the top-right of Metabase and select `New pulse`. ### Name it -First, choose a name for your pulse. This will show up in the email subject line and the Slack message title, so choose something that will let people know what kind of updates the pulse will contain, like “Daily Marketing Update,†or “Users Metrics.†+First, choose a name for your pulse. This will show up in the email subject line and the Slack message title, so choose something that will let people know what kind of updates the pulse will contain, like “Daily Marketing Update,†or “Users Metrics.†Next, choose which collection it should be saved in so that it's easy to find in the future.  @@ -51,18 +49,12 @@ Each pulse you create can be delivered by email, Slack, or both. You can also se To send via Slack, you’ll need to choose which channel you want to post the pulse in, whether you want it to post hourly or daily, and at what time. Again, the schedule for Slack can be different from the schedule for email. -Once you’re done, just click `Create pulse`. You’ll see your new pulse, along with its recipients, and the saved questions that are included in the pulse. If anyone else on your team wants to subscribe to a pulse that’s delivered by email, they can click the button that says `Get this email` from the Pulses screen. - - - -### Editing and Deleting a Pulse -If you ever need to make changes to a pulse, just hover over the pulse from the list and click the `edit` button that appears. - - +Once you’re done, just click `Create pulse` and you’ll see your new pulse in the collection where you chose to save it -If you want to delete a pulse, you can find that option at the bottom of the edit screen. Just remember: if you delete a pulse, no one will receive it anymore. +### Editing or archiving a pulse +If you ever need to make changes to a pulse, just navigate to the collection where it's saved and click on it, or search for it in the big search bar at the top of Metabase. - +If a pulse has outlived its usefulness you can archive it by clicking on the Archive button at the bottom of the pulse's detail page. Just remember: if you archive a pulse, no one will receive it anymore. You can unarchive a pulse just like you can with questions and dashboards by navigating to the archive from the top-right button while viewing any collection and clicking on the View Archive menu option, then clicking on the `Unarchive this` button on the far right next to the pulse. --- diff --git a/docs/users-guide/13-sql-parameters.md b/docs/users-guide/13-sql-parameters.md index 953543fb20b38b03359fd9a5aa7cab9ad115192c..2794f2512d8f7490679672c6dde6b4ba9f5e4ea0 100644 --- a/docs/users-guide/13-sql-parameters.md +++ b/docs/users-guide/13-sql-parameters.md @@ -94,5 +94,5 @@ WHERE True --- -## That’s it! -If you still have questions, or want to share Metabase tips and tricks, head over to our [discussion board](http://discourse.metabase.com/). See you there! +## Next: automated x-ray explorations +Learn about how to easily and quickly see automatic explorations of your data with Metabase's powerful [x-ray feature](14-x-rays.md). diff --git a/docs/users-guide/14-x-rays.md b/docs/users-guide/14-x-rays.md index 09946cf01a2d6df3a1876b3c35a4f3b0dfbff5bd..153994c1790acbfc3fafb2de6ac038a6c214e6a0 100644 --- a/docs/users-guide/14-x-rays.md +++ b/docs/users-guide/14-x-rays.md @@ -2,39 +2,75 @@ --- X-rays are a fast and easy way to get automatic insights and explorations of your data. -### Exploring newly added datasets +### Viewing x-rays by clicking on charts or tables -When you first connect a database to Metabase, Metabot will offer to show you some automated explorations of your data. +One great way to explore your data in general in Metabase is to click on points of interest in charts or tables, which shows you ways to further explore that point. We've added x-rays to this action menu, so if you for example find a point on your line chart that seems extra interesting, give it a click and x-ray it! We think you'll like what you see. - + -Click on one of these to see an x-ray. +### Comparisons - +When you click on a bar or point on a chart, you can now also choose the Compare action from the menu that pops up to see how the thing you've clicked on compares to the rest of the data. -You can see more suggested x-rays over on the right-hand side of the screen. Browsing through x-rays like this is a pretty fun way of getting a quick overview of your data. + -### Saving x-rays +If you're already looking at an x-ray of a table or a segment, Metabase will also give you the option to compare the current table or segment to other segments of the table, if there are any. This is a very fast, powerful way to see, for example, how different segments of your users or orders compare to each other. -If you're logged in as an Administrator and you come across an x-ray that's particularly interesting, you can save it as a dashboard by clicking the green Save button. Metabase will create a new dashboard for you and put all of its charts in a new collection. The new collection and dashboard will only be visible to other Administrators by default. + + -To quickly make your new dashboard visible to other users, go to the collection with its charts, click the lock icon to edit the collection's permissions, and choose which groups should be allowed to view the charts in this collection. Note that this might allow users to see charts and data that they might not normally have access to. For more about how Metabase handles permissions, check out these posts about [collection permissions](../administration-guide/06-collections.md) and [data access permissions](../administration-guide/05-setting-permissions.md). -### Creating x-rays by clicking on charts or tables +### Table x-rays -One great way to explore your data in general in Metabase is to click on points of interest in charts or tables, which shows you ways to further explore that point. We've added x-rays to this action menu, so if you for example find a point on your line chart that seems extra interesting, give it a click and x-ray it! We think you'll like what you see. +Another great way to get to know your data is by x-raying your tables. From the home page, scroll to the bottom of the screen, click on one of your connected databases, and then click the bolt icon on a table to view an x-ray of it. + +### X-raying question results - +You can also see an x-ray of the results of a saved or unsaved question by clicking the blue compass button in the bottom-right of the question screen and selecting the x-ray action. This will show you an x-ray of the numbers and fields in your question's results. -### X-rays in the Data Reference + -You can also create an x-ray by navigating to a table, field, metric, or segment in the [Data Reference](./12-data-model-reference.md). Just click the x-ray link in the left sidebar. +## X-rays in the Data Reference - +You can also view an x-ray by navigating to a table, field, metric, or segment in the [Data Reference](./12-data-model-reference.md). Just click the x-ray link in the lefthand sidebar. + + + +### Browsing through x-rays + +One fun and interesting thing you can do once you're looking at an x-ray is to click and browse through the list of suggested next x-rays that show up in the righthand column. + +Depending on the x-ray you're currently viewing, you'll see suggestions that will let you: + +- compare the table or segment you're currently x-raying to another segment +- "zoom out" and view an x-ray of the table the current x-ray is based on +- "zoom in" to see a more detailed x-ray about a field or dimension of the current x-ray +- go to an x-ray of a related item, like a metric based on the current table, or a different table that's related to the current one + +### Exploring newly added datasets + +If you're an administrator, when you first connect a database to Metabase, Metabot will offer to show you some automated explorations of your newly-connected data. + + + +Click on one of these to see an x-ray. + + + +You can see more suggested x-rays over on the right-hand side of the screen. Browsing through x-rays like this is a pretty fun way of getting a quick overview of your data. + +### Saving x-rays + +If you come across an x-ray that's particularly interesting, you can save it as a dashboard by clicking the green Save button. Metabase will create a new dashboard and put it and all of its charts in a new collection, and will save this new collection wherever you choose. ### Where did the old x-rays go? -We're reworking the way we do things like time series growth analysis and segment comparison, which were present in the previous version of x-rays. In the meantime, we've removed those previous x-rays, and will bring those features back in a more elegant and streamlined way in a future version of Metabase. +We're reworking the way we do things like time series growth analysis, which was present in past versions of x-rays. In the meantime, we've removed those previous x-rays, and will bring those features back in a more elegant and streamlined way in a future version of Metabase. -## Need help? +### Need help? If you still have questions about x-rays or comparisons, you can head over to our [discussion forum](http://discourse.metabase.com/). See you there! + +--- + +## Next: setting up alerts +Learn how to get notified when one of your questions meets or goal or has results with [alerts](15-alerts.md). diff --git a/docs/users-guide/15-alerts.md b/docs/users-guide/15-alerts.md index 03d2f5747c698214ccb2db3b85a4160154fe0fcb..761fc45ba79495381e4cc3f033b6cb41c2a50902 100644 --- a/docs/users-guide/15-alerts.md +++ b/docs/users-guide/15-alerts.md @@ -67,5 +67,7 @@ There are a few ways alerts can be stopped: - If a saved question that has an alert on it gets edited in such a way that the alert doesn't make sense anymore, the alert will get deleted. For example, if a saved question with a goal line alert on it gets edited, and the goal line is removed entirely, that alert will get deleted. - If a question gets archived, any alerts on it will be deleted. +--- + ## That’s it! If you still have questions about using alerts, you can head over to our [discussion forum](http://discourse.metabase.com/). See you there! diff --git a/docs/users-guide/images/MultiSeriesFinished.png b/docs/users-guide/images/MultiSeriesFinished.png index 0b1b8cbfd051960c199522c81f90449903657c33..6c3fa315523e94b55976a000129e94a04dfd3f9e 100644 Binary files a/docs/users-guide/images/MultiSeriesFinished.png and b/docs/users-guide/images/MultiSeriesFinished.png differ diff --git a/docs/users-guide/images/MultiSeriesQueryBuilder.png b/docs/users-guide/images/MultiSeriesQueryBuilder.png index 4ebc8b367f6e66521c5fdd0640a2eb0db78545db..f786b6fcbb1537fbdb159df90fec98507276f326 100644 Binary files a/docs/users-guide/images/MultiSeriesQueryBuilder.png and b/docs/users-guide/images/MultiSeriesQueryBuilder.png differ diff --git a/docs/users-guide/images/MultiSeriesTrigger.png b/docs/users-guide/images/MultiSeriesTrigger.png index 87031ade0e1b1715ad7e21fc9ac5ad482746803f..c3d1a92ab368be0508f917cb44fa98050f48b9c6 100644 Binary files a/docs/users-guide/images/MultiSeriesTrigger.png and b/docs/users-guide/images/MultiSeriesTrigger.png differ diff --git a/docs/users-guide/images/browse-data.png b/docs/users-guide/images/browse-data.png new file mode 100644 index 0000000000000000000000000000000000000000..423205c7fdfdf7482782c08070552760dba6cf99 Binary files /dev/null and b/docs/users-guide/images/browse-data.png differ diff --git a/docs/users-guide/images/collection-detail.png b/docs/users-guide/images/collection-detail.png new file mode 100644 index 0000000000000000000000000000000000000000..5dd7fe9277762c16d3f42b6ee64c0a576450f582 Binary files /dev/null and b/docs/users-guide/images/collection-detail.png differ diff --git a/docs/users-guide/images/create-menu.png b/docs/users-guide/images/create-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..6c93c4798b0f53282f34354ade51eb0725cbfbf3 Binary files /dev/null and b/docs/users-guide/images/create-menu.png differ diff --git a/docs/users-guide/images/dashboard-filters/dashboard-filters.png b/docs/users-guide/images/dashboard-filters/dashboard-filters.png index fb7047329b4c72431aa7f0fb2ed14b4f2ffa2dcf..a0c1f3fdbaff1eea4a582073a7b073b8f6fb52b7 100644 Binary files a/docs/users-guide/images/dashboard-filters/dashboard-filters.png and b/docs/users-guide/images/dashboard-filters/dashboard-filters.png differ diff --git a/docs/users-guide/images/dashboards/DashboardAutorefresh.png b/docs/users-guide/images/dashboards/DashboardAutorefresh.png index 575e3e7ede5c3a39fd9ed0c821028c6438505645..181d45553fedbe2960df63f7817a90272bedd491 100644 Binary files a/docs/users-guide/images/dashboards/DashboardAutorefresh.png and b/docs/users-guide/images/dashboards/DashboardAutorefresh.png differ diff --git a/docs/users-guide/images/dashboards/DashboardCreate.png b/docs/users-guide/images/dashboards/DashboardCreate.png index d70d98746be14ceb6cd4146d123fb4bea31e0e3f..c91a061360afedc84ffa5f131183d1733466a367 100644 Binary files a/docs/users-guide/images/dashboards/DashboardCreate.png and b/docs/users-guide/images/dashboards/DashboardCreate.png differ diff --git a/docs/users-guide/images/dashboards/FilterDashboards.png b/docs/users-guide/images/dashboards/FilterDashboards.png deleted file mode 100644 index 256a90cbd5b8016f6de73ec6aabbf7601f7c710e..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/dashboards/FilterDashboards.png and /dev/null differ diff --git a/docs/users-guide/images/dashboards/FirstDashboard.png b/docs/users-guide/images/dashboards/FirstDashboard.png index 0b4d9084dffb5de17d2b9c0c79237c715ccae5de..a26f97c24747fa2ec9f4623a1e9cd04923574628 100644 Binary files a/docs/users-guide/images/dashboards/FirstDashboard.png and b/docs/users-guide/images/dashboards/FirstDashboard.png differ diff --git a/docs/users-guide/images/dashboards/text-cards/new-text-card.png b/docs/users-guide/images/dashboards/text-cards/new-text-card.png index 1b39a41df73724105e9e6d45a2c3c6225f327b2a..4447cfd80b324fd748147c208efc596e675c1fcf 100644 Binary files a/docs/users-guide/images/dashboards/text-cards/new-text-card.png and b/docs/users-guide/images/dashboards/text-cards/new-text-card.png differ diff --git a/docs/users-guide/images/homepage-x-rays.png b/docs/users-guide/images/homepage-x-rays.png new file mode 100644 index 0000000000000000000000000000000000000000..800eaef33e9b77693affa25877e33d35f008c85e Binary files /dev/null and b/docs/users-guide/images/homepage-x-rays.png differ diff --git a/docs/users-guide/images/metabase-homepage.png b/docs/users-guide/images/metabase-homepage.png new file mode 100644 index 0000000000000000000000000000000000000000..2618c7204ea86349ba48d167b5c10eb83595caa2 Binary files /dev/null and b/docs/users-guide/images/metabase-homepage.png differ diff --git a/docs/users-guide/images/metric-action-menu.png b/docs/users-guide/images/metric-action-menu.png index a43ca62351abd6cc76de3fba1d85e0eb31edd550..c84407afa661081cdc4fe3cd7a8f4657b6a4d921 100644 Binary files a/docs/users-guide/images/metric-action-menu.png and b/docs/users-guide/images/metric-action-menu.png differ diff --git a/docs/users-guide/images/metric-drill-through.png b/docs/users-guide/images/metric-drill-through.png index 094d0a1df59a0a3778caeb37e922d41ee45c47c8..9415a5f9c927fe2a972617a5156b56d20011337f 100644 Binary files a/docs/users-guide/images/metric-drill-through.png and b/docs/users-guide/images/metric-drill-through.png differ diff --git a/docs/users-guide/images/metrics-list.png b/docs/users-guide/images/metrics-list.png index 4abc90ff8d3b784575167c88bdab9b0171c5def2..95b21fb6b7e36dbcd64e0367154846bdcc0832a1 100644 Binary files a/docs/users-guide/images/metrics-list.png and b/docs/users-guide/images/metrics-list.png differ diff --git a/docs/users-guide/images/new-question-all-options.png b/docs/users-guide/images/new-question-all-options.png index d9abb89be58d514d4f4df379ffbcc8e044826c43..fa0a3c9c794e8cbb2d635e0555476f2f4735fe13 100644 Binary files a/docs/users-guide/images/new-question-all-options.png and b/docs/users-guide/images/new-question-all-options.png differ diff --git a/docs/users-guide/images/our-analytics-page.png b/docs/users-guide/images/our-analytics-page.png new file mode 100644 index 0000000000000000000000000000000000000000..ccd13915992b2baee6d16bd8c33a0f474c715ab5 Binary files /dev/null and b/docs/users-guide/images/our-analytics-page.png differ diff --git a/docs/users-guide/images/our-data.png b/docs/users-guide/images/our-data.png new file mode 100644 index 0000000000000000000000000000000000000000..b50515d710e06a45a9a3632bb2dc881cd830d6b4 Binary files /dev/null and b/docs/users-guide/images/our-data.png differ diff --git a/docs/users-guide/images/pinned-items.png b/docs/users-guide/images/pinned-items.png new file mode 100644 index 0000000000000000000000000000000000000000..0453c64cb496530ad7ade11c241f4d49e772f5a8 Binary files /dev/null and b/docs/users-guide/images/pinned-items.png differ diff --git a/docs/users-guide/images/pulses/01-empty-state.png b/docs/users-guide/images/pulses/01-empty-state.png deleted file mode 100644 index 754ae15f99a5d46e999277f721132408916b75fc..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/pulses/01-empty-state.png and /dev/null differ diff --git a/docs/users-guide/images/pulses/02-name-it.png b/docs/users-guide/images/pulses/02-name-it.png index d4402c280ae1a68e490092f30884a83c73e4a3a6..e213cd79e36a1278aebd522356d8e2936e337bcd 100644 Binary files a/docs/users-guide/images/pulses/02-name-it.png and b/docs/users-guide/images/pulses/02-name-it.png differ diff --git a/docs/users-guide/images/pulses/03-pick-your-data.png b/docs/users-guide/images/pulses/03-pick-your-data.png index 6a3bb322f934d20e0328912fbe9f01672a693abd..1e6d730059ee09abf2c9cf785209ce34715fac0f 100644 Binary files a/docs/users-guide/images/pulses/03-pick-your-data.png and b/docs/users-guide/images/pulses/03-pick-your-data.png differ diff --git a/docs/users-guide/images/pulses/06-created.png b/docs/users-guide/images/pulses/06-created.png deleted file mode 100644 index f28e570fbf9cb417d458932e817a870b64627990..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/pulses/06-created.png and /dev/null differ diff --git a/docs/users-guide/images/pulses/07-edit-button.png b/docs/users-guide/images/pulses/07-edit-button.png deleted file mode 100644 index 20e480ec3fb4cde5986dab36e87af53502c75325..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/pulses/07-edit-button.png and /dev/null differ diff --git a/docs/users-guide/images/saved-questions.png b/docs/users-guide/images/saved-questions.png deleted file mode 100644 index 91c771735e8881859e4c34bb7242c96f667f73c3..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/saved-questions.png and /dev/null differ diff --git a/docs/users-guide/images/search-results.png b/docs/users-guide/images/search-results.png new file mode 100644 index 0000000000000000000000000000000000000000..1ecc3053cf328fa26aed14314af2933960a9924c Binary files /dev/null and b/docs/users-guide/images/search-results.png differ diff --git a/docs/users-guide/images/visualizations/add-fields.png b/docs/users-guide/images/visualizations/add-fields.png new file mode 100644 index 0000000000000000000000000000000000000000..988927d832addb29b497cf05d24fb19f4160f60f Binary files /dev/null and b/docs/users-guide/images/visualizations/add-fields.png differ diff --git a/docs/users-guide/images/visualizations/conditional-formatting.png b/docs/users-guide/images/visualizations/conditional-formatting.png new file mode 100644 index 0000000000000000000000000000000000000000..5d60851d3df313450237e8c51ceab98082715a9b Binary files /dev/null and b/docs/users-guide/images/visualizations/conditional-formatting.png differ diff --git a/docs/users-guide/images/x-ray-action-time-series.png b/docs/users-guide/images/x-ray-action-time-series.png deleted file mode 100644 index 63d87d366ba3c20237e16c4bc5eb786a4a9c5c0d..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-action-time-series.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-action.png b/docs/users-guide/images/x-ray-action.png deleted file mode 100644 index 71af33ef3215b973245ab1e630ff8fdd91599141..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-action.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-compare-button.png b/docs/users-guide/images/x-ray-compare-button.png deleted file mode 100644 index 6d57067985412353e6f18e5dc69263405f35eb89..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-compare-button.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-comparison.png b/docs/users-guide/images/x-ray-comparison.png deleted file mode 100644 index 16168753f55ffe08f8589009b93954c11a99bf6d..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-comparison.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-data-reference.png b/docs/users-guide/images/x-ray-data-reference.png deleted file mode 100644 index 2ffd2f11471c03756203b5675f4245e0f33562ac..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-data-reference.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-fidelity.png b/docs/users-guide/images/x-ray-fidelity.png deleted file mode 100644 index c69df7cf32aeb518e6d105fd07ff755ecaca453a..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-fidelity.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray-time-series.png b/docs/users-guide/images/x-ray-time-series.png deleted file mode 100644 index b702da3c37bf76185d1ae8de5456b479a4d03576..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray-time-series.png and /dev/null differ diff --git a/docs/users-guide/images/x-ray.png b/docs/users-guide/images/x-ray.png deleted file mode 100644 index 5e37259405f75d8aa105180568209864e882552b..0000000000000000000000000000000000000000 Binary files a/docs/users-guide/images/x-ray.png and /dev/null differ diff --git a/docs/users-guide/images/x-rays/example.png b/docs/users-guide/images/x-rays/example.png index 629cb481dc3b92199c8907ebe025f02b77d15c2c..4dde0fe6a443cca9744faaa4777b138ece1035ea 100644 Binary files a/docs/users-guide/images/x-rays/example.png and b/docs/users-guide/images/x-rays/example.png differ diff --git a/docs/users-guide/images/x-rays/x-ray-action.png b/docs/users-guide/images/x-rays/x-ray-action.png new file mode 100644 index 0000000000000000000000000000000000000000..3dce83a3e075a23f124892cdb4e07e154fc8ad87 Binary files /dev/null and b/docs/users-guide/images/x-rays/x-ray-action.png differ diff --git a/docs/users-guide/images/x-rays/x-ray-compare-popover.png b/docs/users-guide/images/x-rays/x-ray-compare-popover.png new file mode 100644 index 0000000000000000000000000000000000000000..c871ef88cb01a4b1349943f84122b31ed8081697 Binary files /dev/null and b/docs/users-guide/images/x-rays/x-ray-compare-popover.png differ diff --git a/docs/users-guide/images/x-rays/x-ray-comparison-1.png b/docs/users-guide/images/x-rays/x-ray-comparison-1.png new file mode 100644 index 0000000000000000000000000000000000000000..0d84e73273153b271012e8d1341d0efb6dd2de05 Binary files /dev/null and b/docs/users-guide/images/x-rays/x-ray-comparison-1.png differ diff --git a/docs/users-guide/images/x-rays/x-ray-comparison-2.png b/docs/users-guide/images/x-rays/x-ray-comparison-2.png new file mode 100644 index 0000000000000000000000000000000000000000..258ad9fd8e48d769d1e8eb059e8814303d952e37 Binary files /dev/null and b/docs/users-guide/images/x-rays/x-ray-comparison-2.png differ diff --git a/docs/users-guide/start.md b/docs/users-guide/start.md index 37cc3ea6441293378eea4f0e8fd8d879c6664ee9..a737d161e266d50f99fc8df314992a373fa82df5 100644 --- a/docs/users-guide/start.md +++ b/docs/users-guide/start.md @@ -2,7 +2,7 @@ **This guide will teach you:** -* [What Metabase does](01-what-is-metabase.md) +* [An overview of Metabase](01-what-is-metabase.md) * [The basics of database terminology](02-database-basics.md) * [Basic exploration in Metabase](03-basic-exploration.md) * [Asking questions in Metabase](04-asking-questions.md) diff --git a/frontend/src/metabase/components/BrowseApp.jsx b/frontend/src/metabase/components/BrowseApp.jsx index 0b2af58eb4bd8942262cd2eab71bce10a8b724c1..04745d1998adf5201e6b35ec22ed9de0ba5370bd 100644 --- a/frontend/src/metabase/components/BrowseApp.jsx +++ b/frontend/src/metabase/components/BrowseApp.jsx @@ -105,12 +105,20 @@ export class SchemaBrowser extends React.Component { data-metabase-event={`${ANALYTICS_CONTEXT};Schema Click`} > <Card hoverable px={1}> - <EntityItem - name={schema.name} - iconName="folder" - iconColor={normal.purple} - item={schema} - /> + <Flex align="center"> + <EntityItem + name={schema.name} + iconName="folder" + iconColor={normal.purple} + item={schema} + /> + <Box ml="auto"> + <Icon name="reference" /> + <Tooltip tooltip={t`X-ray this schema`}> + <Icon name="bolt" mx={1} /> + </Tooltip> + </Box> + </Flex> </Card> </Link> </GridItem> diff --git a/frontend/src/metabase/containers/Overworld.jsx b/frontend/src/metabase/containers/Overworld.jsx index 7e8187ccde3bb0b1dd88dce6f70c8d77353cfee6..e47dedc827f280abc760355ae09db885ee946a5b 100644 --- a/frontend/src/metabase/containers/Overworld.jsx +++ b/frontend/src/metabase/containers/Overworld.jsx @@ -8,6 +8,7 @@ import CollectionItemsLoader from "metabase/containers/CollectionItemsLoader"; import CandidateListLoader from "metabase/containers/CandidateListLoader"; import { DatabaseListLoader } from "metabase/components/BrowseApp"; import ExplorePane from "metabase/components/ExplorePane"; +import Tooltip from "metabase/components/Tooltip.jsx"; import * as Urls from "metabase/lib/urls"; import colors, { normal } from "metabase/lib/colors"; @@ -218,7 +219,33 @@ class Overworld extends React.Component { mb={3} size={28} /> - <h3>{database.name}</h3> + <Flex align="center"> + <h3>{database.name}</h3> + <Box ml="auto" mr={1} className="hover-child"> + <Flex align="center"> + <Tooltip tooltip={t`X-ray this table`}> + <Link to={`explore/${database.id}/`}> + <Icon + name="bolt" + mx={1} + color={normal.yellow} + size={20} + /> + </Link> + </Tooltip> + <Tooltip tooltip={t`Learn about this table`}> + <Link + to={`reference/databases/${database.id}`} + > + <Icon + name="reference" + color={normal.grey1} + /> + </Link> + </Tooltip> + </Flex> + </Box> + </Flex> </Box> </Link> </GridItem>