[auto] adding content to release-x.57.x->release-x.57.x (#780)

Co-authored-by: Metabase Docs bot <[email protected]>

Author: github-automation-metabase

_docs/v0.57/api.html

@@ -39,9 +39,11 @@ Appearance settings are split across different tabs:
 
 People can display their Metabase in dark mode in their [account settings](../people-and-groups/account-settings#theme). Options are:
 
- - System default (which is also the default setting). Metabase will switch between light and dark mode when the system switches without having to reload the page.
- - Always use dark mode.
- - Always use light mode. 
+- System default (which is also the default setting). Metabase will switch between light and dark mode when the system switches without having to reload the page.
+- Always use dark mode.
+- Always use light mode.
+
+You can quickly toggle dark mode from anywhere in Metabase by opening the [command palette](../exploration-and-organization/exploration#command-palette) and searching for "light" or "dark" or "theme".
 
 Dark mode is a user-level setting, not an instance-level setting. Currently, there's no way to change the theme to dark mode for the entire instance, but you can edit some [user interface colors](#user-interface-colors).
 

_docs/v0.57/api.json

@@ -162,6 +162,7 @@ config:
     health-check-logging-enabled: true
     help-link: metabase
     help-link-custom-destination: https://www.metabase.com/help/premium
+    hide-stacktraces: false
     http-channel-host-strategy: external-only
     humanization-strategy: simple
     index-update-thread-count: 2
@@ -222,6 +223,13 @@ config:
     query-caching-max-kb: 2000
     query-caching-max-ttl: 3024000.0
     redirect-all-requests-to-https: false
+    remote-sync-auto-import: false
+    remote-sync-auto-import-rate: 5
+    remote-sync-branch: null
+    remote-sync-task-time-limit-ms: 300000
+    remote-sync-token: null
+    remote-sync-type: production
+    remote-sync-url: null
     report-timezone: null
     reset-token-ttl-hours: 48
     retry-initial-interval: 500

_docs/v0.57/configuring-metabase/appearance.md

@@ -114,7 +114,7 @@ Allowed iframe hosts.
 - Default: `true`
 - [Configuration file name](./config-file): `anon-tracking-enabled`
 
-Enable the collection of anonymous usage data to help Metabase improve.
+Enable the collection of anonymous usage data in order to help Metabase improve.
 
 ### `MB_API_KEY`
 
@@ -372,7 +372,7 @@ Whether dashboards should default to a user's last used parameters on load.
 - Type: integer
 - Default: `10000`
 
-Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were unable to
+Consider metabase.driver/can-connect? / can-connect-with-details? to have failed if they were not able to
   successfully connect after this many milliseconds. By default, this is 10 seconds.
 
 Timeout in milliseconds for connecting to databases, both Metabase application database and data connections.
@@ -451,7 +451,7 @@ The name you want to use for the sender of emails.
 - [Configuration file name](./config-file): `email-max-recipients-per-second`
 
 The maximum number of recipients, summed across emails, that can be sent per second.
-                Note that the final email sent before reaching the limit can exceed it, if it has multiple recipients.
+                Note that the final email sent before reaching the limit is able to exceed it, if it has multiple recipients.
 
 ### `MB_EMAIL_REPLY_TO`
 
@@ -754,6 +754,14 @@ Keyword setting to control whitelabeling of the help link. Valid values are `:me
 
 Custom URL for the help link.
 
+### `MB_HIDE_STACKTRACES`
+
+- Type: boolean
+- Default: `false`
+- [Configuration file name](./config-file): `hide-stacktraces`
+
+Prevent the exception middleware from including stacktraces in responses.
+
 ### `MB_HTTP_CHANNEL_HOST_STRATEGY`
 
 - Type: keyword
@@ -1244,7 +1252,7 @@ Indicates whether Metabase is running behind a proxy that sets the source-addres
 By default "Site Url" is used in notification links, but can be overridden.
 
 The base URL where dashboard notitification links will point to instead of the Metabase base URL.
-        Only applicable for users who use interactive embedding and subscriptions.
+        Only applicable for users who utilize interactive embedding and subscriptions.
 
 ### `MB_NOTIFICATION_SYSTEM_EVENT_THREAD_POOL_SIZE`
 
@@ -1313,6 +1321,62 @@ The absolute maximum time to keep any cached query results, in seconds.
 
 Force all traffic to use HTTPS via a redirect, if the site URL is HTTPS.
 
+### `MB_REMOTE_SYNC_AUTO_IMPORT`
+
+- Type: boolean
+- Default: `false`
+- [Configuration file name](./config-file): `remote-sync-auto-import`
+
+Whether to automatically import from the remote git repository. Only applies if remote-sync-type is :production.
+
+### `MB_REMOTE_SYNC_AUTO_IMPORT_RATE`
+
+- Type: integer
+- Default: `5`
+- [Configuration file name](./config-file): `remote-sync-auto-import-rate`
+
+If remote-sync-type is :production and remote-sync-auto-import is true, the rate (in minutes) at which to check for updates to import. Defaults to 5.
+
+### `MB_REMOTE_SYNC_BRANCH`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file): `remote-sync-branch`
+
+The remote branch to sync with, e.g. `main`.
+
+### `MB_REMOTE_SYNC_TASK_TIME_LIMIT_MS`
+
+- Type: integer
+- Default: `300000`
+- [Configuration file name](./config-file): `remote-sync-task-time-limit-ms`
+
+The maximum amount of time a remote sync task will be given to complete.
+
+### `MB_REMOTE_SYNC_TOKEN`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file): `remote-sync-token`
+
+An Authorization Bearer token allowing access to the git repo over HTTP.
+
+### `MB_REMOTE_SYNC_TYPE`
+
+- Type: keyword
+- Default: `production`
+- [Configuration file name](./config-file): `remote-sync-type`
+
+Git synchronization type - :development or :production.
+
+### `MB_REMOTE_SYNC_URL`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file): `remote-sync-url`
+
+The location of your git repository, e.g. https://github.com/acme-inco/metabase.git.
+
 ### `MB_REPORT_TIMEZONE`
 
 - Type: string
@@ -1673,7 +1737,7 @@ When enabled, we show users a button to authenticate with Google to import data
 - [Exported as](../installation-and-operation/serialization): `show-homepage-data`.
 - [Configuration file name](./config-file): `show-homepage-data`
 
-Whether or not to display data on the homepage. Admins might turn this off to direct users to better content than raw data.
+Whether or not to display data on the homepage. Admins might turn this off in order to direct users to better content than raw data.
 
 ### `MB_SHOW_HOMEPAGE_XRAYS`
 
@@ -2135,7 +2199,7 @@ Type: integer<br>
 Default: `600000`<br>
 Since: v35.0
 
-Timeout of Jetty async threads, defined in milliseconds. The default is 10 minutes. Few things might reach that timeout, since they return some type of data before, but things like CSV downloads might.
+Timeout of Jetty async threads, defined in milliseconds. The default is 10 minutes. Very few things might reach that timeout, since they return some type of data before, but things like CSV downloads might.
 
 ### `MB_JETTY_DAEMON`
 

_docs/v0.57/configuring-metabase/config-template.md

@@ -11,14 +11,22 @@ layout: new-docs
 
 # Model persistence
 
-> Currently available for PostgreSQL, MySQL, and Redshift.
-
 Metabase can persist the results of your models so that your models (and the questions based on those models) load faster.
 
 Metabase will store model results in tables in a bespoke schema in your data warehouse (not the Metabase application database). When people ask questions based on your models, Metabase will use the tables with the stored results instead of re-running the model's query.
 
 > Model persistence doesn't work with [row and column security](../permissions/row-and-column-security) or [impersonation](../permissions/impersonation).
 
+## Databases that support model persistence
+
+Currently, model persistence is only available for the following databases:
+
+- PostgreSQL
+- MySQL
+- Redshift
+
+Model persistence doesn't work with [row and column security](../permissions/row-and-column-security) or [impersonation](../permissions/impersonation).
+
 ## Turn on model persistence in Metabase
 
 To persist models for faster loading, you'll need to turn on model persistence for:

_docs/v0.57/configuring-metabase/environment-variables.md

@@ -136,6 +136,10 @@ If you want to replace the existing menu with your own component, you can do so
 {% include_file "{{ dirname }}/snippets/dashboards/plugins.tsx" snippet="example-custom-actions-menu" %}
 ```
 
+### `mapQuestionClickActions`
+
+You can customize what happens when people click on a data point on a dashboard with the `mapQuestionClickActions` plugin. See [mapQuestionClickActions](./questions#mapquestionclickactions).
+
 ## Creating dashboards
 
 Creating a dashboard could be done with `useCreateDashboardApi` hook or `CreateDashboardModal` component.

_docs/v0.57/data-modeling/model-persistence.md

@@ -31,6 +31,43 @@ To use a plugin on a per-component basis, pass the plugin as a prop to the compo
 {% include_file "{{ dirname }}/snippets/plugins/component-plugins.tsx" snippet="example" %}
 ```
 
+## `handleLink`
+
+To customize what happens when people click a link in your embedded questions and dashboards, use the global plugin `handleLink`:
+
+```typescript
+export default function App() {
+  const navigate = useNavigate(); // coming from whatever routing lib you're using
+
+  const plugins = {
+    handleLink: (urlString: string) => {
+      const url = new URL(urlString, window.location.origin);
+      const isInternal = url.origin === window.location.origin;
+      if (isInternal) {
+        // client side navigation
+        navigate(url.pathname + url.search + url.hash);
+
+        return { handled: true }; // prevent default navigation
+      }
+      return { handled: false }; // let the sdk do the default behavior
+    },
+  };
+
+  return (
+    <MetabaseProvider authConfig={authConfig} pluginsConfig={plugins}>
+      <nav style={{ display: "flex", gap: 12, padding: 12 }}>
+        <Link to="/">Home</Link>
+        <Link to="/question">Question</Link>
+        <Link to="/about">About</Link>
+      </nav>
+      <div style={{ padding: 12 }}>
+        <Outlet />
+      </div>
+    </MetabaseProvider>
+  );
+}
+```
+
 ## Further reading
 
 - [Interactive question plugins](./questions#interactive-question-plugins)

_docs/v0.57/embedding/sdk/dashboards.md

@@ -131,8 +131,27 @@ You can use [plugins](./plugins) to add custom functionality to your questions.
 
 ### `mapQuestionClickActions`
 
-This plugin allows you to add custom actions to the click-through menu of an interactive question. You can add and
-customize the appearance and behavior of the custom actions.
+When people click on a data point in the embedded interactive chart, Metabase shows them a menu of actions by default. The plugin `mapQuestionClickActions` allows you to customize this behavior. You can choose to:
+
+- Open the default Metabase menu.
+- Add custom actions to that click-through menu.
+- Perform immediate action without opening a menu.
+
+Use `mapQuestionClickActions` globally at the provider level, or on individual `InteractiveQuestion` or `InteractiveDashboard` components. For more on provider scope, see [Plugins](./plugins)
+
+The example below shows all the options for click action behavior. This example will:
+
+- Open a menu with custom actions when "Last Name" column is clicked.
+- Perform an immediate action (show an alert) when the "Plan" column is clicked.
+- Shows the default menu (available as `clickActions`) in all other cases.
+
+The behavior is determined by what `mapQuestionClickActions` returns: array of actions to open a menu, or a single action to trigger an immediate action.
+
+```typescript
+{% include_file "{{ dirname }}/snippets/questions/interactive-question-click-actions.tsx" snippet="example" %}
+```
+
+You can also customize the appearance of custom actions in the click menu. The example below shows an example of a click menu with default actions, a custom action, and a custom action with customized appearance:
 
 ```typescript
 {% include_file "{{ dirname }}/snippets/questions/interactive-question-plugins.tsx" snippet="example" %}

_docs/v0.57/embedding/sdk/plugins.md

@@ -0,0 +1,46 @@
+import {
+  defineMetabaseAuthConfig,
+  InteractiveQuestion,
+  MetabaseProvider,
+} from "@metabase/embedding-sdk-react";
+
+const authConfig = defineMetabaseAuthConfig({
+  metabaseInstanceUrl: "http://localhost:3000",
+});
+
+const Example = () => {
+  return (
+    // [<snippet example>]
+    <MetabaseProvider
+      authConfig={authConfig}
+      pluginsConfig={{
+        mapQuestionClickActions: (clickActions, clicked) => {
+          if (clicked?.column?.display_name === "Last Name") {
+            // This adds a custom action to the menu when clicked on on "Last Name" column
+            return [
+              ...clickActions,
+              {
+                buttonType: "horizontal",
+                name: "custom",
+                title: "This is the Last Name column",
+                onClick: () => alert("You clicked the Last Name column!"),
+              },
+            ];
+          }
+
+          if (clicked?.column?.display_name === "Plan") {
+            // This performs an immediate action on "Plan" column instead of opening the menu
+            return {
+              onClick: () => alert("You clicked the Plan column!"),
+            };
+          }
+          // default behavior (open Metabase's default click menu) on other columns
+          return clickActions;
+        },
+      }}
+    >
+      <InteractiveQuestion questionId={1} />
+    </MetabaseProvider>
+  );
+  // [<endsnippet example>]
+};