Skip to content

Commit

Permalink
titles and headings (metabase#23331)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-bruemmer authored Jun 14, 2022
1 parent feb006d commit 589e2f7
Show file tree
Hide file tree
Showing 34 changed files with 181 additions and 194 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ title: Metabase documentation

## Paid plans

The Enterprise and Pro editions of Metabase offer additional features.
The Enterprise and Pro plans of Metabase offer additional features.

- [Getting and activating the Enterprise edition](./enterprise-guide/activating-the-enterprise-edition.md)
- [List of premium features](enterprise-guide/start.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/administration-guide/02-setting-up-email.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Setting up Email
title: Setting up email
---

## Setting up Email
# Setting up email

Once you connect your database to Metabase, you'll want to configure an email account to send system notifications to your organization's users. Metabase uses email to reset passwords, onboard new users, and notify you when something happens.

### Configuring your Email Account
## Configuring your email Account

For Metabase to send messages to your organization's users, you'll need to set up an email account to send emails via *SMTP* (simple mail transfer protocol), which is an email standard that secures emails with SSL security protection.

Expand Down Expand Up @@ -49,4 +49,4 @@ You should see this form:
---

## Next: setting up Slack
If you want to use Slack to enhance the Metabase experience then lets do that now. Let’s learn [how to setup Slack](09-setting-up-slack.md).
If you want to use Slack to enhance the Metabase experience then lets do that now. Let’s learn [how to setup Slack](09-setting-up-slack.md).
6 changes: 3 additions & 3 deletions docs/administration-guide/07-segments-and-metrics.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Creating Custom Segments and Metrics
title: Creating custom segments and metrics
---

# Creating Custom Segments and Metrics
# Creating custom segments and metrics

Metabase allows you to create your own segments and metrics so you can quickly and easily reference them in the query builder. Just head over to the **Admin Panel** and select **Data Model** from the top menu.

Expand Down Expand Up @@ -49,4 +49,4 @@ Lastly, you can also view the revision history for each segment and metric from
---

## Next: managing user accounts
Let's learn how to [create and manage accounts for your users](04-managing-users.md).
Let's learn how to [create and manage accounts for your users](04-managing-users.md).
7 changes: 0 additions & 7 deletions docs/administration-guide/11-getting-started-guide.md

This file was deleted.

12 changes: 6 additions & 6 deletions docs/administration-guide/20-custom-maps.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Custom Maps
title: Custom maps
---

## Custom Maps
# Custom maps

By default, Metabase uses OpenStreetMaps for map visualizations, but there are a few customization options.

### Finding Map Settings
## Finding Map Settings

To find the map settings:

Expand All @@ -15,14 +15,14 @@ To find the map settings:

![Map Settings](images/MapSettings.png)

### Map Tile Server
## Map Tile Server

As mentioned above, Metabase uses the OpenStreetMaps tile server. However, if your organization requires a different
look or level of detail in your map visualizations, you can change the map tile server by adding the map tile server
path to the first field on the page. The path must either be a URL that starts with "http://" or "https://" or a
relative path to a local file in the JVM's classpath.

### Custom Region Maps
## Custom Region Maps

If you need a map that focuses on a specific region, you may want to upload a custom GeoJSON map.

Expand All @@ -41,4 +41,4 @@ GeoJSON, we recommend that you start [here](https://geojson.org/).

## Next: editing metadata
Taking just a few minutes to edit and add info to your database’s metadata can greatly enhance your experience with
Metabase. Let’s learn how to [edit your metadata](03-metadata-editing.md).
Metabase. Let’s learn how to [edit your metadata](03-metadata-editing.md).
8 changes: 4 additions & 4 deletions docs/administration-guide/databases/aws-rds.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Connecting to AWS's Relational Database Service (RDS)
title: "Connecting to AWS's Relational Database Service (RDS)"
---

## Connecting to AWS's Relational Database Service (RDS)
# Connecting to AWS's Relational Database Service (RDS)

RDS offers several databases that Metabase officially supports, including PostgreSQL, MySQL, MariaDB, Oracle, and SQL server.

Expand All @@ -17,5 +17,5 @@ Here's how to get connection information for databases on Amazon's RDS:
- **Hostname**. This is listed as the Endpoint parameter.
- **Port**. Find the port parameter under Security and Network.
- **Username**. Find this under Configuration Details.
- **Database Name**. Find this under Configuration Details
- **Password**. Ask your database administrator for the password.
- **Database Name**. Find this under Configuration Details.
- **Password**. Ask your database administrator for the password.
6 changes: 3 additions & 3 deletions docs/administration-guide/start.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Administration Guide
title: Administration guide
---

# Administration Guide
# Administration guide

Are you in charge of managing Metabase for your organization? Then you're in the right spot. You are the chosen one.

Expand Down Expand Up @@ -47,4 +47,4 @@ See [how to install Metabase](../operations-guide/installing-metabase.md).
## Embedding and sharing with public links

- [Sharing dashboards and questions with public links](12-public-links.md)
- [Embedding Metabase in other Applications](13-embedding.md)
- [Embedding Metabase in other Applications](13-embedding.md)
14 changes: 8 additions & 6 deletions docs/code-reviews.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Code reviews
title: "Code reviews"
---

# Code reviews

The overall goal of a code review is to serve as a safety net for other people on our team and help them write better code, not to judge them or their code. When in doubt, assume that they have good intentions and BE NICE.

## Goals:
## Goals

* Catch bugs
* Catch non-obvious consequences of an approach - will this PR make future code harder to secure or more buggy.
Expand All @@ -15,7 +15,7 @@ The overall goal of a code review is to serve as a safety net for other people o
* Point out places where a good approach or style was used. Code reviews are not a hatefest. Unless a PR is completely horrific there should be an equal number of good and bad points brought up.


## Mindset giving a Code Review:
## Mindset giving a code review

Your primary goal as a reviewer is to serve as a safety net and keep bad code from being merged. The definition of “bad” is highly subjective, context dependent and will change with product time and maturity.

Expand All @@ -25,7 +25,7 @@ If you see places where you don’t agree with an approach, speak up. However, a

Look for tricks, techniques, or idioms you can steal. Your teammates are smart folks. Chances are they have tricks that you can learn from. Make a point of letting them know.

## Mindset getting a Code Review:
## Mindset getting a code review

The reviewer is doing you a Solid. They are there to help you do the best work you can. The best of the best have coaches, editors and mentors. Your code reviewers should help you in the same way. In situations where they are more experienced, this can be direct mentoring. In situations where they are more junior, they have a fresh pair of eyes that might get you to question deeply held assumptions.

Expand All @@ -34,7 +34,8 @@ When a reviewer disagrees with an approach you took, seek to understand why. The
If someone slaps a strong :-1: on your PR, be especially patient. Dig into why they think the PR is flawed. Approach the conversation with an intent of making the PR better, not defending your approach. You get no points for being a better debater, but you do get points for shipping better code and a better product, no matter where the inspiration or ideas came from.


## Process:
## Process

* Every PR of significant complexity needs to be :+1:’d by at least one other engineer on the team (or @salsakran) to merge
* Add people you think should review your PR to the PR’s assignees. The reviewer can remove themselves once they have reviewed it, or decided they aren’t an appropriate reviewer
* Code that impacts other engineer’s work should be reviewed by those engineers
Expand All @@ -48,7 +49,8 @@ If someone slaps a strong :-1: on your PR, be especially patient. Dig into why t

Note that these :+1:, :+0:, and :-1:’s should be explicitly stated in a comment, and not a reaction on the main description of the PR on github. A change from :-1: to :+1: should also be stated explicitly on a comment.

## Timing:
## Timing

* PRs for high priority issues should be code reviewed as soon as they are available.
* PRs for issues in a milestone can wait a few days.
* If there are no :+1:'s on a PR, it is the responsibility of the PR creator to follow up with others and get their code reviewed. To re-iterate, a PR needs to be :+1:’d to be merged, and if it has not been reviewed, it is on the opener of the PR to round up a reviewer.
Expand Down
4 changes: 2 additions & 2 deletions docs/developers-guide/driver-changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Driver Interface Changelog
title: Driver interface changelog
---

# Driver Interface Changelog
Expand Down Expand Up @@ -134,4 +134,4 @@ table below:
| 0.38.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.38.0-for-Metabase-driver-authors) |
| 0.37.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.37.0-for-Metabase-driver-authors) |
| 0.36.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.36.0-for-Metabase-driver-authors) |
| 0.35.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.35.0-for-Metabase-driver-authors) |
| 0.35.0 | [changes](https://github.com/metabase/metabase/wiki/What's-new-in-0.35.0-for-Metabase-driver-authors) |
6 changes: 3 additions & 3 deletions docs/developers-guide/e2e-tests.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: End-to-end Tests with Cypress
title: End-to-end tests with Cypress
---

# End-to-end Tests with Cypress
# End-to-end tests with Cypress

Metabase uses Cypress for “end-to-end testing”, that is, tests that are executed against the application as a whole, including the frontend, backend, and application database. These tests are essentially scripts written in JavaScript that run in the web browser: visit different URLs, click various UI elements, type text, and assert that things happen as expected (for example, an element appearing on screen, or a network request occuring).

Expand Down Expand Up @@ -87,4 +87,4 @@ Cypress records videos of each test run, which can be helpful in debugging. Addi


These files can be found under the “Artifacts” tab in Circle:
![Circle CI Artifacts tab](https://user-images.githubusercontent.com/691495/72190614-f5995380-33cd-11ea-875e-4203d6dcf1c1.png)
![Circle CI Artifacts tab](https://user-images.githubusercontent.com/691495/72190614-f5995380-33cd-11ea-875e-4203d6dcf1c1.png)
4 changes: 2 additions & 2 deletions docs/developers-guide/start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Developer's Guide
title: "Developer's Guide"
---

# Developer's Guide
Expand Down Expand Up @@ -37,4 +37,4 @@ This guide contains detailed information on how to work on Metabase codebase.

Learn how to write a driver to connect Metabase to your database.

- [Guide to writing a driver](drivers/start.md)
- [Guide to writing a driver](drivers/start.md)
8 changes: 4 additions & 4 deletions docs/developers-guide/visual-studio-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Developing with Visual Studio Code
---

## Developing with Visual Studio Code
# Developing with Visual Studio Code

### Debugging
## Debugging

First, install the following extension:
* [Debugger for Firefox](https://marketplace.visualstudio.com/items?itemName=firefox-devtools.vscode-firefox-debug)
Expand All @@ -22,7 +22,7 @@ After that, begin the debugging session by choosing menu _Run_, _Start Debugging

For more details, please refer to the complete VS Code documentation on [Debugging](https://code.visualstudio.com/docs/editor/debugging).

### Docker-based Workflow
## Docker-based Workflow

These instructions allow you to work on Metabase codebase on Windows, Linux, or macOS using [Visual Studio Code](https://code.visualstudio.com/), **without** manually installing the necessary dependencies. This is possible by leveraging Docker container and the Remote Containers extension from VS Code.

Expand Down Expand Up @@ -59,4 +59,4 @@ Steps:

5. After a while (after all JavaScript and Clojure dependencies are completely downloaded), open localhost:3000 with your web browser.

See [here](dev-branch-docker.md) for more on running development branches of Metabase using Docker.
See [here](dev-branch-docker.md) for more on running development branches of Metabase using Docker.
10 changes: 5 additions & 5 deletions docs/enterprise-guide/activating-the-enterprise-edition.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Activating your Metabase commercial license
---

## Activating your Metabase commercial license
# Activating your Metabase commercial license

The paid Pro and Enterprise editions of Metabase are distinct from the free Open Source edition, so to use your paid features you’ll need to first get a license. And if you want to self-host, you'll need a different JAR or Docker image that you can use to activate the advanced features with your license token.

### Where to get a license
## Where to get a license

You can get a license by signing up for a free trial of the [Pro or Enterprise edition plans](https://www.metabase.com/pricing), both of which can be self-hosted or hosted on Metabase Cloud.

If you sign up for a Metabase Cloud option, you're already good to go.

### How to activate your token when self-hosting
## How to activate your token when self-hosting

If you chose to host Metabase yourself, you'll get an email containing a unique license token. But to use it, you'll need to install the right JAR file.

Expand All @@ -23,7 +23,7 @@ You can either:

Run Metabase as you would normally, then go to __Settings__ > __Admin settings__, and click __License and Billing__ in the lefthand sidebar. Paste in your license token under __License__ and click __Activate__.

### **Validating your token**
## **Validating your token**

Your Metabase needs to be able to access the internet (specifically `https://store.metabase.com/api/[token-id]/v2/status`) in order to validate the token and maintain access to the advanced features.

Expand All @@ -40,4 +40,4 @@ Depending on your organization’s setup, you may need to take additional config
---

## Next: setting up SSO
We'll walk through how to connect your SSO to Metabase, starting with [SAML-based SSO](authenticating-with-saml.md).
We'll walk through how to connect your SSO to Metabase, starting with [SAML-based SSO](authenticating-with-saml.md).
12 changes: 5 additions & 7 deletions docs/enterprise-guide/authenticating-with-saml-azure-ad.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,19 @@
title: Using Azure AD as the Identity Provider with Metabase and SAML
---

## Using Azure AD as the Identity Provider with Metabase and SAML
# Using Azure AD as the Identity Provider with Metabase and SAML

{% include plans-blockquote.html feature="SAML authentication" %}

## Steps

- [Enable SAML in Metabase](#enable-saml-in-metabase)
- [Add an Enterprise Application in Azure AD](#add-an-enterprise-application-in-azure-ad)
- [Configure the Enterprise Application with Metabase SSO information](#configure-the-enterprise-application-with-metabase-sso-information)

### Enable SAML in Metabase
## Enable SAML in Metabase

First, follow our guide to [enable SAML authentication](authenticating-with-saml.html).

### Add an Enterprise Application in Azure AD
## Add an Enterprise Application in Azure AD

Go to the Azure Active Directory (AD) where your users live and click on **Enterprise Applications**. Once there, click on **+ New Application** in the bar on the top of the page.

Expand Down Expand Up @@ -47,7 +45,7 @@ You'll need these URLs to complete the SSO setup in Metabase.

To finish the Azure side of the configuration, click on the **Users and groups** button on the Manage tab and add the users or groups that should have access to Metabase.

### Configure the Enterprise Application with Metabase SSO information
## Configure the Enterprise Application with Metabase SSO information

Log in to Metabase as an administrator and go to **Admin** -> **Settings** -> **Authentication** -> **SAML**.

Expand All @@ -58,4 +56,4 @@ Under "Tell Metabase about your identity provider", enter the following:
- **SAML Application Name**: "Metabase"
- **SAML Identity Provider Issuer**: the "Azure AD Identifier" URL you got from the Azure AD SAML SSO configuration.

Click on **Save Changes** below, and you should now be able to log in via Azure AD.
Click on **Save Changes** below, and you should now be able to log in via Azure AD.
Loading

0 comments on commit 589e2f7

Please sign in to comment.