Skip to content
Snippets Groups Projects
Commit 52be5402 authored by Maz Ameli's avatar Maz Ameli Committed by GitHub
Browse files

Merge pull request #3494 from metabase/gsg-docs

add docs for GSG feature [ci skip]
parents f550c6a7 8cd296ff
No related branches found
No related tags found
No related merge requests found
......@@ -23,3 +23,9 @@ If you’ve added your Google client id to your Metabase settings you can also l
To enable this, check the box on the Single Sign-On Admin Settings page and specify the email domain you want to allow. For example if you work at WidgetCo you could enter widgetco.com in the field to let anyone with a company email sign up on their own.
Note: Metabase accounts created with Single Sign-On do not have passwords and must use Google to sign in to Metabase.
---
## Next: Creating a Getting Started Guide
Learn how to easily [make a Getting Started Guide](10-getting-started-guide.md) for your team.
## Creating a 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:
![Blank guide](images/gsg/blank-guide.png)
Before you've even created your guide, this page gives you some links on the left that you can use to explore the data you have in Metabase. But for now, click the blue button to begin making your guide. Now you'll see a list of sections that you can include in your guide:
![Sections](images/gsg/sections.png)
You can highlight your company's most important dashboard, [metrics](06-segments-and-metrics.md) that you commonly refer to (and the dimensions by which they're most often grouped), and tables and [segments](06-segments-and-metrics.md) that are useful or interesting. There's also a place to write a little bit more about "gotchas" or caveats in 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:
![Picking items](images/gsg/pick-items.png)
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!
![Finished Guide](images/gsg/finished-guide.png)
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.
NOTE: You'll also notice that the left navigation bar is gone now — that's because the links that it contained are now contextualized within the guide itself.
docs/administration-guide/images/gsg/blank-guide.png

68.8 KiB

docs/administration-guide/images/gsg/finished-guide.png

54.9 KiB

docs/administration-guide/images/gsg/pick-items.png

52.8 KiB

docs/administration-guide/images/gsg/sections.png

47.7 KiB

......@@ -13,6 +13,7 @@ Are you in charge of managing Metabase for your organization? Then you're in the
* [Configuring settings](07-configuration-settings.md)
* [Setting up Slack integration](08-setting-up-slack.md)
* [Enabling single sign-on with Google](09-single-sign-on.md)
* [Creating a Getting Started Guide for your team](10-getting-started-guide.md)
First things first, you'll need to install Metabase. If you haven’t done that yet, our [Installation Guide](../operations-guide/start.md#installing-and-running-metabase) will help you through the process.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment