Docs: cleanup (metabase#12124)

* Remove old FAQ and update a couple of other docs * Prettier [ci skip] * Reset password rewrite and cleanup [ci skip] * Add note about MySQL requirement [ci skip] * Maz suggestion [ci skip] Co-Authored-By: Maz Ameli <[email protected]> Co-authored-by: Maz Ameli <[email protected]>
yogiyo · Mar 18, 2020 · 9bf90b6 · 9bf90b6
1 parent 2b794ee
commit 9bf90b6
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 236 deletions.
diff --git a/docs/developers-guide-drivers.md b/docs/developers-guide-drivers.md
@@ -10,29 +10,36 @@ Want to build your own driver? Take a look at the [driver development](#driver-d
 
 In order to install a community driver, you would typically download the latest jar file from the relevant repository release page and copy it into the plugins directory.
 
-All Metabase plugins live in the plugins directory, which defaults to `./plugins` in the same directory as `metabase.jar`. The plugins directory can be changed by setting the env var `MB_PLUGINS_DIR`. 
-
-Please note that you install these at your own risk. The plugins will run as part of your Metabase instance and, as such, will have access to anything it does. These are the currently known 3rd-party database drivers for Metabase.
-
-| Database | GitHub Stars | Last release (_if available_) |
-| ---- | ---- | ----|
-| [Amazon Athena](https://github.com/dacort/metabase-athena-driver) | ![GitHub stars](https://img.shields.io/github/stars/dacort/metabase-athena-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/dacort/metabase-athena-driver) |
-| [ClickHouse](https://github.com/enqueue/metabase-clickhouse-driver) | ![GitHub stars](https://img.shields.io/github/stars/enqueue/metabase-clickhouse-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/enqueue/metabase-clickhouse-driver) |
-| [CSV](https://github.com/Markenson/csv-metabase-driver) | ![GitHub stars](https://img.shields.io/github/stars/Markenson/csv-metabase-driver) ||
-| [Cube.js](https://github.com/lili-data/metabase-cubejs-driver) | ![GitHub stars](https://img.shields.io/github/stars/lili-data/metabase-cubejs-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/lili-data/metabase-cubejs-driver) |
-| [Datomic](https://github.com/lambdaisland/metabase-datomic) | ![GitHub stars](https://img.shields.io/github/stars/lambdaisland/metabase-datomic) ||
-| [DB2](https://github.com/dludwig-jrt/metabase-db2-driver) | ![GitHub stars](https://img.shields.io/github/stars/dludwig-jrt/metabase-db2-driver) ||
-| [Firebird](https://github.com/evosec/metabase-firebird-driver) | ![GitHub stars](https://img.shields.io/github/stars/evosec/metabase-firebird-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/evosec/metabase-firebird-driver) |
-| [Teradata](https://github.com/swisscom-bigdata/metabase-teradata-driver) | ![GitHub stars](https://img.shields.io/github/stars/swisscom-bigdata/metabase-teradata-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/swisscom-bigdata/metabase-teradata-driver) |
-| [Spark Databricks](https://github.com/ifood/metabase-sparksql-databricks-driver) | ![GitHub stars](https://img.shields.io/github/stars/ifood/metabase-sparksql-databricks-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/ifood/metabase-sparksql-databricks-driver) |
+All Metabase plugins live in the plugins directory, which defaults to `./plugins` in the same directory as `metabase.jar`. The plugins directory can be changed by setting the env var `MB_PLUGINS_DIR`.
+
+**Note:** You install these at your own risk. The plugins will run as part of your Metabase instance and, as such, will have access to anything it does.
+
+These are the currently known 3rd-party database drivers for Metabase.
+
+| Database                                                                         | GitHub Stars                                                                                    | Last release (_if available_)                                                                                           |
+| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| [Amazon Athena](https://github.com/dacort/metabase-athena-driver)                | ![GitHub stars](https://img.shields.io/github/stars/dacort/metabase-athena-driver)              | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/dacort/metabase-athena-driver)              |
+| [ClickHouse](https://github.com/enqueue/metabase-clickhouse-driver)              | ![GitHub stars](https://img.shields.io/github/stars/enqueue/metabase-clickhouse-driver)         | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/enqueue/metabase-clickhouse-driver)         |
+| [CSV](https://github.com/Markenson/csv-metabase-driver)                          | ![GitHub stars](https://img.shields.io/github/stars/Markenson/csv-metabase-driver)              |                                                                                                                         |
+| [Cube.js](https://github.com/lili-data/metabase-cubejs-driver)                   | ![GitHub stars](https://img.shields.io/github/stars/lili-data/metabase-cubejs-driver)           | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/lili-data/metabase-cubejs-driver)           |
+| [Datomic](https://github.com/lambdaisland/metabase-datomic)                      | ![GitHub stars](https://img.shields.io/github/stars/lambdaisland/metabase-datomic)              |                                                                                                                         |
+| [DB2](https://github.com/dludwig-jrt/metabase-db2-driver)                        | ![GitHub stars](https://img.shields.io/github/stars/dludwig-jrt/metabase-db2-driver)            |                                                                                                                         |
+| [Firebird](https://github.com/evosec/metabase-firebird-driver)                   | ![GitHub stars](https://img.shields.io/github/stars/evosec/metabase-firebird-driver)            | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/evosec/metabase-firebird-driver)            |
+| [Materialize](https://github.com/MaterializeInc/metabase-materialize-driver)     | ![GitHub stars](https://img.shields.io/github/stars/MaterializeInc/metabase-materialize-driver) | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/MaterializeInc/metabase-materialize-driver) |
+| [Teradata](https://github.com/swisscom-bigdata/metabase-teradata-driver)         | ![GitHub stars](https://img.shields.io/github/stars/swisscom-bigdata/metabase-teradata-driver)  | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/swisscom-bigdata/metabase-teradata-driver)  |
+| [Spark Databricks](https://github.com/ifood/metabase-sparksql-databricks-driver) | ![GitHub stars](https://img.shields.io/github/stars/ifood/metabase-sparksql-databricks-driver)  | ![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/ifood/metabase-sparksql-databricks-driver)  |
+
+If you don't see a driver for your database, then try looking in the comments of the [issue related to the database](https://github.com/metabase/metabase/labels/Database%2F). You might also find more by [searching on GitHub](https://github.com/search?q=metabase+driver).
+
+If you are having problems with installing or using a community driver, your best bet is to contact the author of the driver.
 
 ## Driver development
 
 If the driver you're looking for isn't available, take a look at the [Writing a Driver](https://github.com/metabase/metabase/wiki/Writing-a-Driver) wiki page. It's still a work in progress, but should give you a good start. A few things to keep in mind:
 
 - If your database has a JDBC driver, you'll be able to make use of some common classes that already exist in Metabase.
 - We're still working on providing an independent test framework for drivers, but you can copy or symlink your driver into a local copy of the Metabase source code in order to utilize pre-existing tests. Take a look at [Test Extension Basics](https://github.com/metabase/metabase/wiki/Writing-a-Driver:-Adding-Test-Extensions,-Tests,-and-Setting-up-CI#test-extensions-basics) on the wiki.
-- If you have questions related to driver development, feel free to post on our [driver development forum](https://discourse.metabase.com/c/driver-development). 
+- If you have questions related to driver development, feel free to post on our [driver development forum](https://discourse.metabase.com/c/driver-development).
 
 ## Driver development announcements
 

diff --git a/docs/enterprise-guide/serialization.md b/docs/enterprise-guide/serialization.md
@@ -4,31 +4,32 @@ Once you really get rolling with Metabase it's often the case that you'll have m
 
 To help you out in situations like this, Metabase has a serialization feature which lets you create a snapshot, called a dump, of the contents of a Metabase instance that can then be loaded into another instance. This lets you do things like create a set of dashboards and charts in one Metabase instance and then easily copy those items to a number of other Metabase instances. You could also use this feature to enable a staging-to-production workflow for important dashboards or reports by dumping from a staging instance of Metabase and then loading that dump into your production instance(s). You can even put the dump files into version control and audit changes to them, as the YAML files contained within the dump are pretty readable.
 
+If you're looking to do a one-time migration from H2 to MySQL/Postgres, then use the [migration guide instead](../operations-guide/migrating-from-h2.md).
 
 ### What gets dumped and loaded
 
 **Currently, dumps consist of the following Metabase artifacts:**
 
-* Collections
-* Dashboards
-* Saved questions
-* Pulses
-* Segments and Metrics defined in the Data Model
-* Archived collections, dashboards, saved questions, or pulses
-* Public sharing settings for questions and dashboards
+- Collections
+- Dashboards
+- Saved questions
+- Pulses
+- Segments and Metrics defined in the Data Model
+- Archived collections, dashboards, saved questions, or pulses
+- Public sharing settings for questions and dashboards
 
 **They also contain a number of system settings:**
 
-* Admin Panel settings, except for permissions
-* Database connection settings
-* Data Model settings
+- Admin Panel settings, except for permissions
+- Database connection settings
+- Data Model settings
 
 **Dumps do _not_ contain:**
 
-* Permission settings
-* User accounts or settings
-* Alerts on saved questions
-* Personal Collections or their contents (except for the user specified with the `--user` flag; see below)
+- Permission settings
+- User accounts or settings
+- Alerts on saved questions
+- Personal Collections or their contents (except for the user specified with the `--user` flag; see below)
 
 ### Before creating or loading a dump