The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Check docs links in the source code and against the live sites (GRO-1061) (#83843)
Timur Masharabfb13dda3dba
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.ymlindex fec2210f148..174f9cad471 100644--- a/.github/ISSUE_TEMPLATE/bug_report.yml+++ b/.github/ISSUE_TEMPLATE/bug_report.yml@@ -54,7 +54,7 @@ body:description: |Please include relevant JavaScript console logs from the "console" tab in the browser dev tools.Additionally, include Metabase server logs (`Settings -> Admin -> Troubleshooting -> Logs`) around the time this bug occurred.- For information about how to get these, consult our [bug troubleshooting guide](https://metabase.com/docs/latest/troubleshooting-guide/bugs.html)+ For information about how to get these, consult our [bug troubleshooting guide](https://www.metabase.com/docs/latest/troubleshooting-guide/bugs)validations:required: falsediff --git a/.github/file-paths.yaml b/.github/file-paths.yamlindex b192c36cc49..bf85f91ba48 100644--- a/.github/file-paths.yaml+++ b/.github/file-paths.yaml@@ -301,6 +301,14 @@ documentation:docs:- "docs/**"+# The calls to useDocsUrl/getDocsUrl, the pages they link to, and bin/verify-doc-links, which checks+# one against the other in .github/workflows/docs-links.yml.+in_product_docs_links:+ - *frontend_sources+ - "docs/**/*.md"+ - "bin/verify-doc-links/**"+ - ".github/workflows/docs-links.yml"+embedding_documentation: &embedding_documentation- ".typedoc/**"- "docs/embedding/**"diff --git a/.github/scripts/file-paths.unit.spec.ts b/.github/scripts/file-paths.unit.spec.tsindex fa528794e0f..1ce38458c86 100644--- a/.github/scripts/file-paths.unit.spec.ts+++ b/.github/scripts/file-paths.unit.spec.ts@@ -167,6 +167,20 @@ describe("file-paths.yaml", () => {).toBe(false);});+ it.each([+ "docs/embedding/guest-embedding.md",+ "frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.tsx",+ "bin/verify-doc-links/verify-doc-links.ts",+ ])("checks the in-product docs links when %s changes", (path) => {+ expect(matches("in_product_docs_links", path)).toBe(true);+ });++ it("does not check the in-product docs links for a docs image", () => {+ expect(+ matches("in_product_docs_links", "docs/embedding/images/guest.png"),+ ).toBe(false);+ });+it("runs the ratchet check on the ratchets file", () => {expect(matches("project_ratchet_checks", ".clj-kondo/ratchets.edn")).toBe(true,diff --git a/.github/scripts/report-links.ts b/.github/scripts/report-links.tsnew file mode 100644index 00000000000..a858dfbae23--- /dev/null+++ b/.github/scripts/report-links.ts@@ -0,0 +1,109 @@+// usage: bun report-links.ts <report.md>+// A non-empty report opens the Linear issue or replaces its description; an empty or missing one closes it.+import { existsSync, readFileSync } from "node:fs";++const TITLE = "metabase/metabase broken links report";++type Issue = { id: string; identifier: string; url: string };++async function linear<T>(+ query: string,+ variables: Record<string, unknown> = {},+): Promise<T> {+ const response = await fetch("https://api.linear.app/graphql", {+ method: "POST",+ headers: {+ "Content-Type": "application/json",+ Authorization: process.env.LINEAR_API_KEY ?? "",+ },+ body: JSON.stringify({ query, variables }),+ });+ const body = (await response.json()) as { data?: T; errors?: unknown };+ if (!response.ok || body.errors || !body.data) {+ throw new Error(+ `Linear API error: ${JSON.stringify(body.errors ?? response.status)}`,+ );+ }+ return body.data;+}++async function slack(text: string) {+ const response = await fetch("https://slack.com/api/chat.postMessage", {+ method: "POST",+ headers: {+ "Content-Type": "application/json; charset=utf-8",+ Authorization: `Bearer ${process.env.SLACK_BOT_TOKEN}`,+ },+ body: JSON.stringify({ channel: process.env.SLACK_CHANNEL, text }),+ });+ const body = (await response.json()) as { ok: boolean; error?: string };+ if (!body.ok) {+ throw new Error(`Slack API error: ${body.error}`);+ }+}++const file = process.argv[2];+const report =+ file && existsSync(file) ? readFileSync(file, "utf8").trim() : "";+const teamId = process.env.LINEAR_TEAM_ID;+const runUrl = process.env.RUN_URL;+const link = (issue: Issue) => `<${issue.url}|${issue.identifier}>`;++const { issues } = await linear<{ issues: { nodes: Issue[] } }>(+ `query($teamId: ID!, $title: String!) {+ issues(first: 1, filter: {+ team: { id: { eq: $teamId } },+ title: { eq: $title },+ state: { type: { nin: ["completed", "canceled"] } }+ }) { nodes { id identifier url } }+ }`,+ { teamId, title: TITLE },+);+const open = issues.nodes[0];++if (report && open) {+ await linear(+ `mutation($id: String!, $description: String!) {+ issueUpdate(id: $id, input: { description: $description }) { success }+ }`,+ { id: open.id, description: report },+ );+ console.log(`Updated ${open.identifier}`);+} else if (report) {+ const { issueCreate } = await linear<{ issueCreate: { issue: Issue } }>(+ `mutation($teamId: String!, $title: String!, $description: String!) {+ issueCreate(input: { teamId: $teamId, title: $title, description: $description }) {+ issue { id identifier url }+ }+ }`,+ { teamId, title: TITLE, description: report },+ );+ await slack(+ `:link: The weekly link check found broken links in metabase/metabase: ${link(issueCreate.issue)}`,+ );+ console.log(`Opened ${issueCreate.issue.identifier}`);+} else if (open) {+ const { team } = await linear<{+ team: { states: { nodes: { id: string }[] } };+ }>(+ `query($teamId: String!) {+ team(id: $teamId) { states(filter: { type: { eq: "completed" } }) { nodes { id } } }+ }`,+ { teamId },+ );+ await linear(+ `mutation($id: String!, $stateId: String!, $body: String!) {+ issueUpdate(id: $id, input: { stateId: $stateId }) { success }+ commentCreate(input: { issueId: $id, body: $body }) { success }+ }`,+ {+ id: open.id,+ stateId: team.states.nodes[0].id,+ body: `All links pass as of ${runUrl}`,+ },+ );+ await slack(+ `:white_check_mark: All links in metabase/metabase pass again, closed ${link(open)}`,+ );+ console.log(`Closed ${open.identifier}`);+}diff --git a/.github/workflows/docs-links-site.yml b/.github/workflows/docs-links-site.ymlnew file mode 100644index 00000000000..c41a3e6b0c0--- /dev/null+++ b/.github/workflows/docs-links-site.yml@@ -0,0 +1,122 @@+name: Check links against the live sites++on:+ schedule:+ # Sundays at 05:00 UTC+ - cron: "0 5 * * 0"+ workflow_dispatch:++jobs:+ live-links:+ name: Check links against the live sites+ if: ${{ github.event_name != 'schedule' || github.repository == 'metabase/metabase' }}+ runs-on: ${{ vars.DEFAULT_RUNNER_KEY }}+ timeout-minutes: 15+ permissions:+ contents: read+ env:+ LINKS_REPORT: broken-links.txt+ RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}+ SLACK_CHANNEL: C0AL5E179P0 # #growth-alerts+ steps:+ - name: Checkout repository+ uses: actions/checkout@v7+ with:+ sparse-checkout: |+ .lychee+ .github/ISSUE_TEMPLATE+ .github/scripts+ docs+ frontend/src+ enterprise/frontend/src+ src+ enterprise/backend/src+ resources+ modules++ - name: Install lychee+ env:+ LYCHEE_VERSION: "0.24.2"+ LYCHEE_SHA256: 1f4e0ef7f6554a6ed33dd7ac144fb2e1bbed98598e7af973042fc5cd43951c9a+ run: |+ archive=lychee-x86_64-unknown-linux-gnu.tar.gz+ curl -sSfL -o "$archive" "https://github.com/lycheeverse/lychee/releases/download/lychee-v${LYCHEE_VERSION}/$archive"+ echo "$LYCHEE_SHA256 $archive" | sha256sum -c -+ tar xzf "$archive"+ sudo install lychee-x86_64-unknown-linux-gnu/lychee /usr/local/bin/lychee++ - name: Check links+ id: check+ continue-on-error: true+ env:+ # lychee uses it for github.com, which rate-limits anonymous requests.+ GITHUB_TOKEN: ${{ github.token }}+ run: |+ status=0+ docs/util/check-links.sh site || status=1+ docs/util/check-links.sh --external || status=1+ exit "$status"++ - name: Build the broken links report+ if: steps.check.outcome == 'failure'+ env:+ BLOB_URL: ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}+ run: |+ max_rows=300+ {+ echo "> Generated by [\`docs-links-site.yml\`]($BLOB_URL/.github/workflows/docs-links-site.yml). Each weekly run replaces this description, so edits here are lost: comment instead."+ echo+ if [ -s "$LINKS_REPORT" ]; then+ failures=$(sort -u "$LINKS_REPORT")+ count=$(grep -c '' <<<"$failures")+ echo "The weekly link check found **$count broken links** on $(date -u +%Y-%m-%d) ([run]($RUN_URL))."+ echo "A redirect counts as broken for metabase.com and our GitHub wikis: see \`docs/util/README.md\`."+ echo+ echo "| Where | Link | Status |"+ echo "| --- | --- | --- |"+ head -n "$max_rows" <<<"$failures" | while IFS= read -r failure; do+ location=${failure%%: *}+ rest=${failure#*: }+ url=${rest%%: *}+ status=$(sed -E 's/^Rejected status code: ([0-9]+).*/\1/' <<<"${rest#*: }")+ echo "| [\`$location\`]($BLOB_URL/${location%:*}#L${location##*:}) | ${url//|/\\|} | ${status//|/\\|} |"+ done+ if [ "$count" -gt "$max_rows" ]; then+ echo+ echo "…and $((count - max_rows)) more in the run."+ fi+ else+ echo "The weekly link check failed on $(date -u +%Y-%m-%d) without listing any links. See the [run]($RUN_URL)."+ fi+ } > broken-links-issue.md++ - name: Install bun+ uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0+ with:+ bun-version-file: "package.json"+ token: ${{ secrets.GITHUB_TOKEN }}++ # Keeps one open Linear issue: a failing run opens it or replaces its description, a passing run closes it.+ # Slack hears when it opens or closes. Only master reports: a manual run on a branch checks that branch.+ - name: Open, update, or close the broken links issue+ if: github.ref == 'refs/heads/master'+ env:+ LINEAR_API_KEY: ${{ secrets.LINEAR_API_KEY }}+ LINEAR_TEAM_ID: fc363549-4f40-41ed-8f41-8fba461606ab # GRO+ SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}+ run: bun .github/scripts/report-links.ts broken-links-issue.md++ - name: Alert when the link check can't run+ if: failure() && github.ref == 'refs/heads/master'+ env:+ SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}+ run: |+ jq -n --arg channel "$SLACK_CHANNEL" --arg text ":x: The weekly metabase/metabase link check failed to run: $RUN_URL" \+ '{channel: $channel, text: $text}' |+ curl -sSf https://slack.com/api/chat.postMessage \+ -H "Authorization: Bearer $SLACK_BOT_TOKEN" \+ -H "Content-Type: application/json; charset=utf-8" --data @-++ - name: Fail the run+ if: steps.check.outcome == 'failure'+ run: exit 1diff --git a/.github/workflows/docs-links.yml b/.github/workflows/docs-links.ymlindex 942f2646c78..015fda2c3da 100644--- a/.github/workflows/docs-links.yml+++ b/.github/workflows/docs-links.yml@@ -18,23 +18,59 @@ jobs:sparse-checkout: |docs.lychee+ .github/ISSUE_TEMPLATE+ frontend/src+ enterprise/frontend/src+ src+ enterprise/backend/src+ resources+ modules- - name: Cache lychee- uses: actions/cache@v5- with:- path: ~/.cache/lychee- key: lychee-${{ runner.os }}-${{ hashFiles('.lychee/config.toml') }}+ - name: Install lychee+ env:+ LYCHEE_VERSION: "0.24.2"+ LYCHEE_SHA256: 1f4e0ef7f6554a6ed33dd7ac144fb2e1bbed98598e7af973042fc5cd43951c9a+ run: |+ archive=lychee-x86_64-unknown-linux-gnu.tar.gz+ curl -sSfL -o "$archive" "https://github.com/lycheeverse/lychee/releases/download/lychee-v${LYCHEE_VERSION}/$archive"+ echo "$LYCHEE_SHA256 $archive" | sha256sum -c -+ tar xzf "$archive"+ sudo install lychee-x86_64-unknown-linux-gnu/lychee /usr/local/bin/lychee- - name: Run link checker- id: link-check- uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2.9.0- with:- fail: true- args: docs --config ./.lychee/config.toml --offline- format: markdown+ - name: Check links in docs/+ run: docs/util/check-links.sh docs- # lychee can't read the YAML nav, so this script renders it as markdown first. lychee is on PATH- # from the step above.+ # lychee can't read the YAML nav, so this script renders it as markdown first.- name: Check nav.yml linksif: ${{ !cancelled() }}run: docs/util/check-links.sh nav++ - name: Check docs links in the source code+ if: ${{ !cancelled() }}+ run: docs/util/check-links.sh src++ gate:+ permissions:+ contents: read+ pull-requests: read+ uses: ./.github/workflows/test.gate.yml+ with:+ filters: in_product_docs_links++ # Runs when the docs change too, so a docs-only PR that renames a page can't break in-product links.+ in-product-links:+ name: Check in-product docs links+ needs: gate+ if: ${{ needs.gate.outputs.run == 'true' }}+ runs-on: ${{ vars.DEFAULT_RUNNER_KEY }}+ timeout-minutes: 10+ permissions:+ contents: read+ steps:+ - uses: actions/checkout@v7+ - name: Prepare front-end environment+ uses: ./.github/actions/prepare-frontend+ with:+ apply-patches: "false"+ - name: Check in-product docs links+ run: bun bin/verify-doc-links/verify-doc-links.tsdiff --git a/.lychee/config.toml b/.lychee/config.tomlindex c1893123c95..8abc1a68998 100644--- a/.lychee/config.toml+++ b/.lychee/config.toml@@ -1,16 +1,23 @@accept = ["200..=204", "429"]exclude = [- "\\.html(#.*)?$",# Liquid templates ({{page.version}}) in docs/embedding/sdk are rendered by the docs site, not here."%7B%7B",# Bot-blocked: 403 for anything that isn't a browser."^https://(www|dev)\\.mysql\\.com/","^https://platform\\.deepseek\\.com/","^https://console\\.x\\.ai/",+ "^https://www\\.oreilly\\.com/",+ # API base URLs the docs give as values: they answer API requests, not page loads.+ "^https://ollama\\.com/v1$",# Login-walled: redirects forever between console and auth."^https://console\\.mistral\\.ai/",# GitHub renders issue comments client-side, so lychee can't see #issuecomment anchors."^https://github\\.com/.+/issues/\\d+#issuecomment-",+ # Same for a repo's #readme anchor.+ "^https://github\\.com/[^/]+/[^/]+#readme$",+ # The API reference is rendered client-side by Scalar, so lychee can't see its #tag/... anchors.+ "^https://www\\.metabase\\.com/docs/latest/api#",+ "api\\.html#tag/",]exclude_path = ["docs/util", "docs/embedding/sdk/api"]no_progress = truediff --git a/README.md b/README.mdindex 0724c61a87c..44b64f422ab 100644--- a/README.md+++ b/README.md@@ -16,16 +16,16 @@ You get expert support, backups, upgrades, an SMTP server, SSL certificate, SoC2## Key Features-- [Set up in five minutes](https://www.metabase.com/docs/latest/configuring-metabase/setting-up-metabase) (we're not kidding), or have us [host Metabase for you](https://www.metabase.com/cloud/) so you don't even need to think about it.+- [Set up in five minutes](https://www.metabase.com/docs/latest/configuring-metabase/setting-up-metabase) (we're not kidding), or have us [host Metabase for you](https://www.metabase.com/cloud) so you don't even need to think about it.- Let anyone on your team [ask questions](https://www.metabase.com/docs/latest/questions/introduction) without knowing SQL.- Use the [SQL editor](https://www.metabase.com/docs/latest/questions/native-editor/writing-sql) for more complex queries.- Ask AI: [Metabot](https://www.metabase.com/docs/latest/ai/metabot) gives you answers you can trust, helps you write queries, and more. Or build your own [AI agent](https://www.metabase.com/docs/latest/ai/agent-api) to query your data.- Build handsome, interactive [dashboards](https://www.metabase.com/docs/latest/dashboards/introduction) with filters, auto-refresh, fullscreen, custom click behavior, and more.- Use [documents](https://www.metabase.com/docs/latest/documents/introduction) for long-form data analysis, and invite people to comment.-- [Transform](https://www.metabase.com/docs/latest/data-studio/transforms/transforms-overview) raw data into analytics-ready tables, track down broken dependencies, and define canonical metrics in Metabase's [Data Studio](https://www.metabase.com/docs/latest/data-studio/overview).+- [Transform](https://www.metabase.com/docs/latest/data-modeling/transforms/transforms-overview) raw data into analytics-ready tables, track down broken dependencies, and define canonical metrics in Metabase's [Data Studio](https://www.metabase.com/docs/latest/data-modeling/data-studio).- Set up [alerts on your data](https://www.metabase.com/docs/latest/questions/alerts), or schedule [dashboard subscriptions](https://www.metabase.com/docs/latest/dashboards/subscriptions) to email, Slack, or even a webhook.-- Curate content in a [Library](https://www.metabase.com/docs/latest/data-studio/library), and [version your work with Git](https://www.metabase.com/docs/latest/installation-and-operation/remote-sync).-- [Embed Metabase in your app](https://www.metabase.com/docs/latest/embedding/introduction), with components for charts, dashboards, data browser, AI chat, and more. You can even put [an entire Metabase](https://www.metabase.com/docs/latest/embedding/interactive-embedding) in your app.+- Curate content in a [Library](https://www.metabase.com/docs/latest/data-modeling/semantic-layer/library), and [version your work with Git](https://www.metabase.com/docs/latest/installation-and-operation/remote-sync).+- [Embed Metabase in your app](https://www.metabase.com/docs/latest/embedding/introduction), with components for charts, dashboards, data browser, AI chat, and more. You can even put [an entire Metabase](https://www.metabase.com/docs/latest/embedding/full-app-embedding) in your app.- Set granular [permissions](https://www.metabase.com/docs/latest/permissions/introduction) that work for both internal teams and embedded analytics, whether you co-locate your customer data, or give each customer their own database.- Dark mode, content translations, and way more stuff than we can list here.@@ -55,7 +55,7 @@ Hit our API to integrate analytics. Check out our guide, [Working with the Metab## Internationalization-We want Metabase to be available in as many languages as possible. See which translations are available and help contribute to internationalization using our project over at [Crowdin](https://crowdin.com/project/metabase-i18n). You can also check out our [policies on translations](https://www.metabase.com/docs/latest/administration-guide/localization.html).+We want Metabase to be available in as many languages as possible. See which translations are available and help contribute to internationalization using our project over at [Crowdin](https://crowdin.com/project/metabase-i18n). You can also check out our [policies on translations](https://www.metabase.com/docs/latest/configuring-metabase/localization).## Security Disclosure@@ -63,7 +63,7 @@ See [SECURITY.md](./SECURITY.md) for details.## License-This repository contains the source code for both the Open Source edition of Metabase, released under the AGPL, as well as the [commercial editions of Metabase](https://www.metabase.com/pricing/), which are released under the Metabase Commercial Software License.+This repository contains the source code for both the Open Source edition of Metabase, released under the AGPL, as well as the [commercial editions of Metabase](https://www.metabase.com/pricing), which are released under the Metabase Commercial Software License.See [LICENSE.txt](./LICENSE.txt) for details.@@ -79,4 +79,4 @@ Unless otherwise noted, all files © 2026 Metabase, Inc.## Metabase Experts-If you’d like more technical resources to set up your data stack with Metabase, connect with a [Metabase Expert](https://www.metabase.com/partners/?utm_source=readme&utm_medium=metabase-expetrs&utm_campaign=readme).+If you’d like more technical resources to set up your data stack with Metabase, connect with a [Metabase Expert](https://www.metabase.com/partners?utm_source=readme&utm_medium=metabase-expetrs&utm_campaign=readme).diff --git a/bin/verify-doc-links b/bin/verify-doc-linksdeleted file mode 100755index 2b12708d535..00000000000--- a/bin/verify-doc-links+++ /dev/null@@ -1,47 +0,0 @@-#!/usr/bin/env node--const fs = require("fs");-const glob = require("glob");-const chalk = require("chalk");--init();--function verifyDocumentationLinks(files) {- let missing = 0;- for (const file of files) {- const text = fs.readFileSync(file, "utf-8");- const regex = /docsUrl\((?:[\s\n]+)?"([^"]+)"/g;- let match;- while ((match = regex.exec(text))) {- const [_, page, anchor] = match;- const path = `./docs/${page}.md`;- if (fs.existsSync(path)) {- console.log(`Exists: ${path}`);- } else {- console.log(chalk.red(`Missing: ${path}`));- missing++;- }- }- }- if (missing > 0) {- process.exit(missing);- }-}--function verifyAllFiles() {- glob("./{enterprise/,}frontend/src/**/*.{js,jsx,ts,tsx}", (err, files) => {- if (err) {- console.error(err);- process.exit(1);- }- verifyDocumentationLinks(files);- });-}--function init() {- const stagedFiles = process.argv.slice(2);-- return stagedFiles.length- ? verifyDocumentationLinks(stagedFiles)- : verifyAllFiles();-}diff --git a/bin/verify-doc-links/verify-doc-links.ts b/bin/verify-doc-links/verify-doc-links.tsnew file mode 100755index 00000000000..3e8bdce9e1e--- /dev/null+++ b/bin/verify-doc-links/verify-doc-links.ts@@ -0,0 +1,153 @@+#!/usr/bin/env bun+/* eslint-disable no-console */+import { existsSync, readFileSync } from "fs";++import { sync as globSync } from "glob";+import ts from "typescript";++type ArgPosition = number | [index: number, property: string];++// verify-doc-links.unit.spec.ts imports these helpers, so renaming one fails that spec.+export const DOCS_URL_HELPERS: Record<+ string,+ { page: ArgPosition; anchor: ArgPosition }+> = {+ useDocsUrl: { page: 0, anchor: [1, "anchor"] },+ getDocsUrl: { page: [1, "page"], anchor: [1, "anchor"] },+ getDocsUrlForVersion: { page: 1, anchor: 2 },+};++export type DocsLink = { line: number; page: string; anchor?: string };++const literalText = (node: ts.Node | undefined) =>+ node && (ts.isStringLiteral(node) || ts.isNoSubstitutionTemplateLiteral(node))+ ? node.text+ : undefined;++const argAt = (call: ts.CallExpression, position: ArgPosition) => {+ if (typeof position === "number") {+ return literalText(call.arguments[position]);+ }+ const [index, property] = position;+ const arg = call.arguments[index];+ if (!arg || !ts.isObjectLiteralExpression(arg)) {+ return undefined;+ }+ const prop = arg.properties.find(+ (p): p is ts.PropertyAssignment =>+ ts.isPropertyAssignment(p) && p.name.getText() === property,+ );+ return literalText(prop?.initializer);+};++// Calls whose page isn't a literal (a variable, a template with ${}) are skipped.+export function extractDocsLinks(fileName: string, text: string): DocsLink[] {+ const source = ts.createSourceFile(+ fileName,+ text,+ ts.ScriptTarget.Latest,+ true,+ );+ const links: DocsLink[] = [];+ const visit = (node: ts.Node) => {+ if (ts.isCallExpression(node) && ts.isIdentifier(node.expression)) {+ const helper = DOCS_URL_HELPERS[node.expression.text];+ const page = helper && argAt(node, helper.page);+ if (page) {+ const { line } = source.getLineAndCharacterOfPosition(node.getStart());+ links.push({+ line: line + 1,+ page,+ anchor: argAt(node, helper.anchor),+ });+ }+ }+ ts.forEachChild(node, visit);+ };+ visit(source);+ return links;+}++// Same ids as GitHub: the docs site keeps leading digits and underscores ("2. Add `MB_API_KEY`"+// becomes "2-add-mb_api_key"), and drops the markers around _emphasis_.+export function headingIds(markdown: string): Set<string> {+ const ids = new Set<string>();+ let inFence = false;+ for (const line of markdown.split("\n")) {+ if (/^\s*(```|~~~)/.test(line)) {+ inFence = !inFence;+ }+ const heading = !inFence && line.match(/^#{1,6}\s+(.*?)\s*#*\s*$/);+ if (!heading) {+ continue;+ }+ const explicit = heading[1].match(/\{#([^}\s]+)}\s*$/);+ if (explicit) {+ ids.add(explicit[1]);+ continue;+ }+ const base = heading[1]+ .replace(/\[([^\]]*)]\([^)]*\)/g, "$1")+ .replace(/[`*]|\b_|_\b/g, "")+ .toLowerCase()+ .replace(/[^\p{L}\p{M}\p{N}\p{Pc} -]/gu, "")+ .replace(/ /g, "-");+ let id = base;+ for (let n = 1; ids.has(id); n++) {+ id = `${base}-${n}`;+ }+ ids.add(id);+ }+ return ids;+}++export function checkLink({ page, anchor }: DocsLink, docsDir = "docs") {+ const path = `${docsDir}/${page.replace(/\.html$/, "")}.md`;+ if (!existsSync(path)) {+ return `${path} doesn't exist (if the page moved, the new page lists the old path under redirect_from)`;+ }+ if (anchor && !headingIds(readFileSync(path, "utf-8")).has(anchor)) {+ return `${path} has no heading with id #${anchor}`;+ }+ return undefined;+}++// Specs and stories call the helpers with made-up pages.+const isChecked = (file: string) => !/\.(unit\.spec|stories)\./.test(file);++const main = () => {+ const staged = process.argv.slice(2);+ const files = (+ staged.length+ ? staged+ : globSync("{enterprise/,}frontend/src/**/*.{js,jsx,ts,tsx}")+ ).filter(isChecked);++ let checked = 0;+ let broken = 0;+ for (const file of files) {+ for (const link of extractDocsLinks(file, readFileSync(file, "utf-8"))) {+ checked++;+ const error = checkLink(link);+ if (error) {+ broken++;+ const target = link.anchor ? `${link.page}#${link.anchor}` : link.page;+ console.log(`${file}:${link.line}: ${target}: ${error}`);+ }+ }+ }++ // A full run that finds nothing means the helpers changed shape, not that every link is fine.+ if (!staged.length && checked === 0) {+ console.log(+ "Found no docs links. Update DOCS_URL_HELPERS in bin/verify-doc-links/verify-doc-links.ts.",+ );+ process.exit(1);+ }+ console.log(`Checked ${checked} docs links, ${broken} broken`);+ process.exit(broken ? 1 : 0);+};++if (require.main === module) {+ main();+}diff --git a/bin/verify-doc-links/verify-doc-links.unit.spec.ts b/bin/verify-doc-links/verify-doc-links.unit.spec.tsnew file mode 100644index 00000000000..04d2fea2a41--- /dev/null+++ b/bin/verify-doc-links/verify-doc-links.unit.spec.ts@@ -0,0 +1,104 @@+import { mkdirSync, mkdtempSync, writeFileSync } from "fs";+import { tmpdir } from "os";+import { join } from "path";++import { useDocsUrl } from "metabase/common/hooks/use-docs-url";+import { getDocsUrl, getDocsUrlForVersion } from "metabase/selectors/settings";++import {+ DOCS_URL_HELPERS,+ checkLink,+ extractDocsLinks,+ headingIds,+} from "./verify-doc-links";++describe("DOCS_URL_HELPERS", () => {+ it("lists the helpers that build docs urls, so renaming one fails here", () => {+ expect(Object.keys(DOCS_URL_HELPERS).sort()).toEqual(+ [useDocsUrl.name, getDocsUrl.name, getDocsUrlForVersion.name].sort(),+ );+ });+});++describe("extractDocsLinks", () => {+ it("finds the page and anchor in every helper call shape", () => {+ const source = `+ useDocsUrl("a/b");+ useDocsUrl(+ "c/d",+ { anchor: "e" },+ );+ getDocsUrl(state, { page: "f/g", anchor: "h" });+ getDocsUrlForVersion(version, "i/j", "k");+ useDocsUrl(\`l/m\`);+ useDocsUrl(\`dynamic/\${page}\`);+ useDocsUrl(page);+ getDocsUrl(state, { searchQuery: "x" });+ `;+ expect(extractDocsLinks("x.tsx", source)).toEqual([+ { line: 2, page: "a/b", anchor: undefined },+ { line: 3, page: "c/d", anchor: "e" },+ { line: 7, page: "f/g", anchor: "h" },+ { line: 8, page: "i/j", anchor: "k" },+ { line: 9, page: "l/m", anchor: undefined },+ ]);+ });+});++describe("headingIds", () => {+ it("generates the ids the docs site generates", () => {+ const ids = headingIds(+ [+ "# Title",+ "### 2. Add a new endpoint",+ "### `MB_API_KEY`",+ "## Security warning: each end-user _must_ have a `token`",+ "## [Linked](https://example.com) heading",+ "## Custom {#my-id}",+ "## Title",+ "```",+ "# not a heading",+ "```",+ ].join("\n"),+ );+ expect([...ids]).toEqual([+ "title",+ "2-add-a-new-endpoint",+ "mb_api_key",+ "security-warning-each-end-user-must-have-a-token",+ "linked-heading",+ "my-id",+ "title-1",+ ]);+ });+});++describe("checkLink", () => {+ const docsDir = mkdtempSync(join(tmpdir(), "docs-"));+ mkdirSync(join(docsDir, "questions"));+ writeFileSync(+ join(docsDir, "questions/alerts.md"),+ "# Alerts\n## Create an alert\n",+ );++ it("accepts a page and anchor that exist", () => {+ expect(+ checkLink(+ { line: 1, page: "questions/alerts", anchor: "create-an-alert" },+ docsDir,+ ),+ ).toBeUndefined();+ });++ it("rejects a page that doesn't exist, like one that only survives as a redirect", () => {+ expect(+ checkLink({ line: 1, page: "questions/sharing/alerts" }, docsDir),+ ).toMatch(/doesn't exist/);+ });++ it("rejects a missing anchor", () => {+ expect(+ checkLink({ line: 1, page: "questions/alerts", anchor: "nope" }, docsDir),+ ).toMatch(/no heading/);+ });+});diff --git a/dev/email-preview/sample-contexts.js b/dev/email-preview/sample-contexts.jsindex 520645482b8..f8d43421aef 100644--- a/dev/email-preview/sample-contexts.js+++ b/dev/email-preview/sample-contexts.js@@ -112,14 +112,14 @@ window.SAMPLE_CONTEXTS = {heading: "We hope you've been enjoying Metabase.",callToAction:"Would you mind taking a quick 5 minute survey to tell us how it's going?",- link: "https://metabase.com/feedback/active",+ link: "https://www.metabase.com/feedback/active",},creator_sentiment_email: {emailType: "notification",logoHeader: true,"first-name": "Meredith",- link: "https://metabase.com/feedback/creator",+ link: "https://www.metabase.com/feedback/creator","self-hosted": "http://localhost:3000",},diff --git a/docs/api.json b/docs/api.jsonindex 9555a48080d..c1bfe77cce6 100644--- a/docs/api.json+++ b/docs/api.json@@ -63339,7 +63339,7 @@"post" : {"operationId" : "post-api-notify-db-id","summary" : "POST /api/notify/db/{id}",- "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)",+ "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables#mb_api_key)","parameters" : [ {"in" : "path","name" : "id",diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.mdindex 265067db6e4..98ad9069eed 100644--- a/docs/configuring-metabase/config-template.md+++ b/docs/configuring-metabase/config-template.md@@ -163,7 +163,7 @@ config:gsheets: nullhealth-check-logging-enabled: truehelp-link: metabase- help-link-custom-destination: https://www.metabase.com/help/premium+ help-link-custom-destination: https://www.metabase.com/help-premiumhide-stacktraces: falsehumanization-strategy: simpleindex-update-thread-count: 2diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.mdindex 0bb6a202197..a3c71f72885 100644--- a/docs/configuring-metabase/environment-variables.md+++ b/docs/configuring-metabase/environment-variables.md@@ -891,7 +891,7 @@ Keyword setting to control whitelabeling of the help link. Valid values are `:me> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.- Type: string-- Default: `https://www.metabase.com/help/premium`+- Default: `https://www.metabase.com/help-premium`- [Configuration file name](./config-file.md): `help-link-custom-destination`Custom URL for the help link.diff --git a/docs/dashboards/interactive.md b/docs/dashboards/interactive.mdindex e864147a65d..26917875e1e 100644--- a/docs/dashboards/interactive.md+++ b/docs/dashboards/interactive.md@@ -95,10 +95,10 @@ What we need to do here is to type in the full URL of where a user should go wheFor example, we could type a URL like this:```-https://www.metabase.com/search.html?query={% raw %}{{Category}}{% endraw %}+https://www.metabase.com/search?query={% raw %}{{Category}}{% endraw %}```-The important part is the `{% raw %}{{Category}}{% endraw %}` bit. What we’re doing here is referring to the `Category` that the user clicked on. So if someone clicks on the `Widget` bar in our chart, the value of the `Category` column for that bar (`Widget`) would be inserted into our URL: `https://www.metabase.com/search.html?query=Widget`. Your URL can use as many column variables as you want - you can even refer to the same column multiple times in different parts of the URL. To see which variables you can include in the URL, click on the dropdown menu **Values you can reference**.+The important part is the `{% raw %}{{Category}}{% endraw %}` bit. What we’re doing here is referring to the `Category` that the user clicked on. So if someone clicks on the `Widget` bar in our chart, the value of the `Category` column for that bar (`Widget`) would be inserted into our URL: `https://www.metabase.com/search?query=Widget`. Your URL can use as many column variables as you want - you can even refer to the same column multiple times in different parts of the URL. To see which variables you can include in the URL, click on the dropdown menu **Values you can reference**.Next we’ll click **Done**, then **Save** our dashboard. Now when we click our chart, we’ll be taken to the URL that we entered above, with the value of the clicked bar inserted into the URL.diff --git a/docs/data-modeling/models/model-persistence.md b/docs/data-modeling/models/model-persistence.mdindex 2d60be11354..077acb9e53b 100644--- a/docs/data-modeling/models/model-persistence.md+++ b/docs/data-modeling/models/model-persistence.md@@ -38,7 +38,7 @@ To turn on model persistence for your Metabase, go to **Admin** > **Performance*You can set models to refresh based on one of the default frequencies (every 1 hour, 2 hours, etc.), or select the **Custom** option to use [cron syntax](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) to specify your own update frequency.-The cron scheduler uses the [default instance report Timezone](../../configuring-metabase/localization.md#set-default-instance-report-timezone) if selected. Otherwise the scheduler will use the System Timezone (which defaults to GMT in [Metabase Cloud](https://www.metabase.com/cloud/)).+The cron scheduler uses the [default instance report Timezone](../../configuring-metabase/localization.md#set-default-instance-report-timezone) if selected. Otherwise the scheduler will use the System Timezone (which defaults to GMT in [Metabase Cloud](https://www.metabase.com/cloud)).We recommend scheduling your models to refresh on a frequency that makes sense with how often your source tables update with new data.diff --git a/docs/data-modeling/models/models.md b/docs/data-modeling/models/models.mdindex 841e2bac911..7740b8c05c2 100644--- a/docs/data-modeling/models/models.md+++ b/docs/data-modeling/models/models.md@@ -68,7 +68,7 @@ To view a model's details, visit the model and click on the **info** button in t- **History**: Lists changes to the model, and by whom.- **Relationships**: Lists which questions use the model, and which tables the model is linked to.- **Actions**: Lists actions created based on the model.-- **Insights**: Info about the [model's usage](../../usage-and-performance-tools/usage-analytics.md). Only visible to admins on a [Pro or Enterprise plan](https://www.metabase.com/pricing/).+- **Insights**: Info about the [model's usage](../../usage-and-performance-tools/usage-analytics.md). Only visible to admins on a [Pro or Enterprise plan](https://www.metabase.com/pricing).## Add metadata to columns in a modeldiff --git a/docs/databases/connections/oracle.md b/docs/databases/connections/oracle.mdindex b21b5136dfd..36f7254f94c 100644--- a/docs/databases/connections/oracle.md+++ b/docs/databases/connections/oracle.md@@ -94,7 +94,7 @@ certificate chain. Refer to the[Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html) on using `keytool` to manage key and truststore files, importing certificates, etc.For more information on setting up a truststore for AWS RDS Oracle instances, see the-[instructions provided by Amazon](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.html#Appendix.Oracle.Options.SSL.JDBC).+[instructions provided by Amazon](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.SSL.JDBC.html).If you need to connect to other databases using SSL, instead of creating a new truststore, you'll probably want to add the RDS CA to your existing truststore file (likely called `cacerts`).diff --git a/docs/developers-guide/docs.md b/docs/developers-guide/docs.mdindex af86dd2fb51..a803a29d2dd 100644--- a/docs/developers-guide/docs.md+++ b/docs/developers-guide/docs.md@@ -20,7 +20,7 @@ This command uses [Markdown link check](https://github.com/tcort/markdown-link-ctouch ~/links-to-fix.txt && bun run docs-lint-links > ~/links-to-fix.txt```-Alternatively, if you just want to check the in-product links to make sure they link to actual documents:+Alternatively, if you just want to check the in-product links (the pages passed to `useDocsUrl` and `getDocsUrl`) to make sure they link to actual documents and headings:```bun run lint-docs-linksdiff --git a/docs/developers-guide/drivers/plugins.md b/docs/developers-guide/drivers/plugins.mdindex 731ba11536d..9419cd40fe8 100644--- a/docs/developers-guide/drivers/plugins.md+++ b/docs/developers-guide/drivers/plugins.md@@ -117,7 +117,7 @@ dependencies:# management page as well in the futuremessage: >Metabase requires the Oracle JDBC driver to connect to JDBC databases. See- https://metabase.com/docs/latest/administration-guide/databases/oracle.html+ https://www.metabase.com/docs/latest/databases/connections/oraclefor more details# A 'plugin' dependency checks whether a given plugin is available.diff --git a/docs/embedding/sdk/api/EditableDashboard.html b/docs/embedding/sdk/api/EditableDashboard.htmlindex 34bfb8c0581..424b38eecf3 100644--- a/docs/embedding/sdk/api/EditableDashboard.html+++ b/docs/embedding/sdk/api/EditableDashboard.html@@ -23,10 +23,10 @@ This is either:</div></li><li class="tsd-parameter"><h5 id="drillthroughquestionprops"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">drillThroughQuestionProps</span><span class="tsd-signature-symbol">?: </span><a href="DrillThroughQuestionProps.html" class="tsd-signature-type tsd-kind-interface">DrillThroughQuestionProps</a></h5><div class="tsd-comment tsd-typography"><p>Props of a question component when drilled from the dashboard to a question level.</p></div></li><li class="tsd-parameter"><h5 id="enableentitynavigation"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">enableEntityNavigation</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>When true, internal click behaviors (links to dashboards/questions) are preserved.When false (default for SDK), these click behaviors are filtered out.</p>-</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -42,7 +42,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -63,7 +63,7 @@ or when the user changes the visualization type of a question.</p><br/>Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/EditableDashboardProps.html b/docs/embedding/sdk/api/EditableDashboardProps.htmlindex 0bc5504ebc8..ffaf20c7f25 100644--- a/docs/embedding/sdk/api/EditableDashboardProps.html+++ b/docs/embedding/sdk/api/EditableDashboardProps.html@@ -74,10 +74,10 @@ For each parameter:</div></li><li class="tsd-parameter"><h5 id="witheditorbutton"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withEditorButton</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines whether the editor button is shown. Only relevant when using the default layout.</p></div></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enableentitynavigation"><code class="tsd-tag">Optional</code><span>enable<wbr/>Entity<wbr/>Navigation</span><a href="#enableentitynavigation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableEntityNavigation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When true, internal click behaviors (links to dashboards/questions) are preserved.When false (default for SDK), these click behaviors are filtered out.</p>-</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -93,7 +93,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -115,7 +115,7 @@ or when the user changes the visualization type of a question.</p><br/>Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/InteractiveDashboard.html b/docs/embedding/sdk/api/InteractiveDashboard.htmlindex 5cb476481a2..9ab893e76bf 100644--- a/docs/embedding/sdk/api/InteractiveDashboard.html+++ b/docs/embedding/sdk/api/InteractiveDashboard.html@@ -30,7 +30,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -47,7 +47,7 @@ For each parameter:<br/>Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -56,17 +56,17 @@ Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsdUse namespaced InteractiveQuestion components to build the layout.</p></div></li></ul><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dashboardId</span><span class="tsd-signature-symbol">?: </span><a href="SdkDashboardId.html" class="tsd-signature-type tsd-kind-type-alias">SdkDashboardId</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">token</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h5></li></ul><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">enableEntityNavigation</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>When true, internal click behaviors (links to dashboards/questions) are preserved.When false (default for SDK), these click behaviors are filtered out.</p>-</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">initialParameters</span><span class="tsd-signature-symbol">?: </span><a href="ParameterValues.html" class="tsd-signature-type tsd-kind-type-alias">ParameterValues</a></h5><div class="tsd-comment tsd-typography"><p>Query parameters for the dashboard. For a single option, use a <code>string</code> value, and use a list of strings for multiple options.<br/></p><ul>-<li>Combining <a href="#interactivedashboard" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="#interactivedashboard" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="#interactivedashboard" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/InteractiveDashboardProps.html b/docs/embedding/sdk/api/InteractiveDashboardProps.htmlindex 7035a7efa82..a4fd5aa4215 100644--- a/docs/embedding/sdk/api/InteractiveDashboardProps.html+++ b/docs/embedding/sdk/api/InteractiveDashboardProps.html@@ -71,10 +71,10 @@ For each parameter:</div></li><li class="tsd-parameter"><h5 id="witheditorbutton"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withEditorButton</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines whether the editor button is shown. Only relevant when using the default layout.</p></div></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enableentitynavigation"><code class="tsd-tag">Optional</code><span>enable<wbr/>Entity<wbr/>Navigation</span><a href="#enableentitynavigation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableEntityNavigation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When true, internal click behaviors (links to dashboards/questions) are preserved.When false (default for SDK), these click behaviors are filtered out.</p>-</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -90,7 +90,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -112,7 +112,7 @@ or when the user changes the visualization type of a question.</p><br/>Pair with <a href="#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="#parameters" class="tsd-kind-property">parameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="#parameters" class="tsd-kind-property">parameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="#parameters" class="tsd-kind-property">parameters</a> and <a href="#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/MetabaseProvider.html b/docs/embedding/sdk/api/MetabaseProvider.htmlindex 11659f1ba2b..978040b3460 100644--- a/docs/embedding/sdk/api/MetabaseProvider.html+++ b/docs/embedding/sdk/api/MetabaseProvider.html@@ -27,7 +27,7 @@ your page's Content Security Policy does not allow <code>'unsafe-eval'</code>.</</div></li><li class="tsd-parameter"><h5 id="locale"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Defines the display language. Accepts an ISO language code such as <code>en</code> or <code>de</code>.Defaults to the instance locale.</p></div></li><li class="tsd-parameter"><h5 id="pluginsconfig"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pluginsConfig</span><span class="tsd-signature-symbol">?: </span><a href="MetabaseGlobalPluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseGlobalPluginsConfig</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/plugins">Plugins</a>.</p>-</div></li><li class="tsd-parameter"><h5 id="theme"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">theme</span><span class="tsd-signature-symbol">?: </span><a href="MetabaseEmbeddingTheme.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseEmbeddingTheme</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/appearance">Appearance</a>.</p>+</div></li><li class="tsd-parameter"><h5 id="theme"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">theme</span><span class="tsd-signature-symbol">?: </span><a href="MetabaseEmbeddingTheme.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseEmbeddingTheme</a></h5><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/appearance">Appearance</a>.</p></div></li><li class="tsd-parameter"><h5 id="uselegacymonolithicbundle"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">useLegacyMonolithicBundle</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to load the full SDK bundle directly as a single file (legacy behavior),instead of the optimized bootstrap that loads chunks in parallel and startsauthentication early.</p>diff --git a/docs/embedding/sdk/api/MetabaseProviderProps.html b/docs/embedding/sdk/api/MetabaseProviderProps.htmlindex 1eaefd2dfdf..de6955f2ab2 100644--- a/docs/embedding/sdk/api/MetabaseProviderProps.html+++ b/docs/embedding/sdk/api/MetabaseProviderProps.html@@ -39,7 +39,7 @@ your page's Content Security Policy does not allow <code>'unsafe-eval'</code>.</</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="locale"><code class="tsd-tag">Optional</code><span>locale</span><a href="#locale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Defines the display language. Accepts an ISO language code such as <code>en</code> or <code>de</code>.Defaults to the instance locale.</p></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pluginsconfig"><code class="tsd-tag">Optional</code><span>plugins<wbr/>Config</span><a href="#pluginsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pluginsConfig</span><span class="tsd-signature-symbol">?:</span> <a href="MetabaseGlobalPluginsConfig.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseGlobalPluginsConfig</a></div><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/plugins">Plugins</a>.</p>-</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="theme"><code class="tsd-tag">Optional</code><span>theme</span><a href="#theme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">theme</span><span class="tsd-signature-symbol">?:</span> <a href="MetabaseEmbeddingTheme.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseEmbeddingTheme</a></div><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/sdk/appearance">Appearance</a>.</p>+</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="theme"><code class="tsd-tag">Optional</code><span>theme</span><a href="#theme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">theme</span><span class="tsd-signature-symbol">?:</span> <a href="MetabaseEmbeddingTheme.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseEmbeddingTheme</a></div><div class="tsd-comment tsd-typography"><p>See <a href="https://www.metabase.com/docs/latest/embedding/appearance">Appearance</a>.</p></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uselegacymonolithicbundle"><code class="tsd-tag">Optional</code><span>use<wbr/>Legacy<wbr/>Monolithic<wbr/>Bundle</span><a href="#uselegacymonolithicbundle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useLegacyMonolithicBundle</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to load the full SDK bundle directly as a single file (legacy behavior),instead of the optimized bootstrap that loads chunks in parallel and startsauthentication early.</p>diff --git a/docs/embedding/sdk/api/StaticDashboard.html b/docs/embedding/sdk/api/StaticDashboard.htmlindex a12c489321c..5e484f754af 100644--- a/docs/embedding/sdk/api/StaticDashboard.html+++ b/docs/embedding/sdk/api/StaticDashboard.html@@ -17,10 +17,10 @@ This is either:<br/></li><li>the string ID found in the <code>entity_id</code> key of the dashboard object when using the API directly or using the SDK Collection Browser to return data</li></ul>-</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></li><li class="tsd-parameter"><h5 id="hiddenparameters"><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -36,7 +36,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -57,7 +57,7 @@ or when the user changes the visualization type of a question.</p><br/>Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/StaticDashboardProps.html b/docs/embedding/sdk/api/StaticDashboardProps.htmlindex b377ff450c2..725ee95850a 100644--- a/docs/embedding/sdk/api/StaticDashboardProps.html+++ b/docs/embedding/sdk/api/StaticDashboardProps.html@@ -33,10 +33,10 @@ This is either:<br/></li><li>the string ID found in the <code>entity_id</code> key of the dashboard object when using the API directly or using the SDK Collection Browser to return data</li></ul>-</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters">parameters to hide</a>.+</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hiddenparameters"><code class="tsd-tag">Optional</code><span>hidden<wbr/>Parameters</span><a href="#hiddenparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hiddenParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of <a href="https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters">parameters to hide</a>.<br/></p><ul>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -52,7 +52,7 @@ For each parameter:<li>omitted (or set to <code>undefined</code>): falls back to the parameter's default (or <code>null</code> if it has no default).<br/><br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#initialparameters" class="tsd-kind-property">initialParameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>@@ -74,7 +74,7 @@ or when the user changes the visualization type of a question.</p><br/>Pair with <a href="InteractiveDashboardProps.html#onparameterschange" class="tsd-kind-property">onParametersChange</a> to stay in sync with user edits.<br/></li>-<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.+<li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to filter data on the frontend is a <a href="https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account">security risk</a>.<br/></li><li>Combining <a href="InteractiveDashboardProps.html#parameters" class="tsd-kind-property">parameters</a> and <a href="InteractiveDashboardProps.html#hiddenparameters" class="tsd-kind-property">hiddenParameters</a> to declutter the user interface is fine.</li></ul>diff --git a/docs/embedding/sdk/api/snippets/EditableDashboardProps.md b/docs/embedding/sdk/api/snippets/EditableDashboardProps.mdindex bf81fa1037d..9b1be6cfa7f 100644--- a/docs/embedding/sdk/api/snippets/EditableDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/EditableDashboardProps.md@@ -4,29 +4,29 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="datapickerprops"></a> `dataPickerProps?` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`SdkQuestionProps`](./api/SdkQuestionProps.md), `"entityTypes"` \| `"dataPicker"`\> | Additional props to pass to the query builder rendered by `InteractiveQuestion` when creating a new dashboard question. Set `dataPicker: "staged"` to always get the staged data picker. By default, Metabase shows a simple dropdown menu with tables and models, and only switches to the staged picker when there are 100 or more data sources. `entityTypes: ["question"]` only takes effect in the staged picker. |-| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |-| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |-| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | - |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="datapickerprops"></a> `dataPickerProps?` | [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)\<[`SdkQuestionProps`](./api/SdkQuestionProps.md), `"entityTypes"` \| `"dataPicker"`\> | Additional props to pass to the query builder rendered by `InteractiveQuestion` when creating a new dashboard question. Set `dataPicker: "staged"` to always get the staged data picker. By default, Metabase shows a simple dropdown menu with tables and models, and only switches to the staged picker when there are 100 or more data sources. `entityTypes: ["question"]` only takes effect in the staged picker. |+| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |+| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |+| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | - |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md b/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.mdindex 43a36206fa2..a8867f1c9c1 100644--- a/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/InteractiveDashboardProps.md@@ -4,28 +4,28 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |-| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |-| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | - |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId` | `string` \| `number` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="drillthroughquestionheight"></a> `drillThroughQuestionHeight?` | `Height`\<`string` \| `number`\> | Height of a question component when drilled from the dashboard to a question level. |+| <a id="drillthroughquestionprops"></a> `drillThroughQuestionProps?` | [`DrillThroughQuestionProps`](./api/DrillThroughQuestionProps.md) | Props of a question component when drilled from the dashboard to a question level. |+| <a id="enableentitynavigation"></a> `enableEntityNavigation?` | `boolean` | When true, internal click behaviors (links to dashboards/questions) are preserved. When false (default for SDK), these click behaviors are filtered out. |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="renderdrillthroughquestion"></a> `renderDrillThroughQuestion?` | () => [`ReactNode`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L478) | A custom React component to render the question layout. Use namespaced InteractiveQuestion components to build the layout. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | - |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md b/docs/embedding/sdk/api/snippets/MetabaseProviderProps.mdindex 5fc5059cd72..027bdee3147 100644--- a/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md+++ b/docs/embedding/sdk/api/snippets/MetabaseProviderProps.md@@ -17,7 +17,7 @@| <a id="loadercomponent"></a> `loaderComponent?` | [`ComponentType`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L104)\<\{ `label?`: `string`; \}\> | A custom loader component to display while the SDK is loading. The component receives an optional `label` prop that can be used to display a loading message. || <a id="locale"></a> `locale?` | `string` | Defines the display language. Accepts an ISO language code such as `en` or `de`. Defaults to the instance locale. || <a id="pluginsconfig"></a> `pluginsConfig?` | [`MetabaseGlobalPluginsConfig`](./api/MetabaseGlobalPluginsConfig.md) | See [Plugins](https://www.metabase.com/docs/latest/embedding/sdk/plugins). |-| <a id="theme"></a> `theme?` | [`MetabaseEmbeddingTheme`](./api/MetabaseEmbeddingTheme.md) | See [Appearance](https://www.metabase.com/docs/latest/embedding/sdk/appearance). |+| <a id="theme"></a> `theme?` | [`MetabaseEmbeddingTheme`](./api/MetabaseEmbeddingTheme.md) | See [Appearance](https://www.metabase.com/docs/latest/embedding/appearance). || <a id="uselegacymonolithicbundle"></a> `useLegacyMonolithicBundle?` | `boolean` | Whether to load the full SDK bundle directly as a single file (legacy behavior), instead of the optimized bootstrap that loads chunks in parallel and starts authentication early. Defaults to false (uses the optimized bootstrap loader). |<!-- [<endsnippet properties>] -->diff --git a/docs/embedding/sdk/api/snippets/StaticDashboardProps.md b/docs/embedding/sdk/api/snippets/StaticDashboardProps.mdindex 97f6e7e1377..689202c00d9 100644--- a/docs/embedding/sdk/api/snippets/StaticDashboardProps.md+++ b/docs/embedding/sdk/api/snippets/StaticDashboardProps.md@@ -4,24 +4,24 @@<!-- [<snippet properties>] -->-| Property | Type | Description |-| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |-| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |-| <a id="dashboardid"></a> `dashboardId?` | [`SdkDashboardId`](./api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |-| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |-| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |-| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |-| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |-| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |-| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |-| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |-| <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. |-| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |-| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |-| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |-| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |+| Property | Type | Description |+| :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| <a id="autorefreshinterval"></a> `autoRefreshInterval?` | `number` | The interval between auto refreshes on the dashboard, in seconds. |+| <a id="classname"></a> `className?` | `string` | A custom class name to be added to the root element. |+| <a id="dashboardid"></a> `dashboardId?` | [`SdkDashboardId`](./api/SdkDashboardId.md) \| `null` | The ID of the dashboard. <br/> This is either: <br/> - the numerical ID when accessing a dashboard link, i.e. `http://localhost:3000/dashboard/1-my-dashboard` where the ID is `1` <br/> - the string ID found in the `entity_id` key of the dashboard object when using the API directly or using the SDK Collection Browser to return data |+| <a id="hiddenparameters"></a> `hiddenParameters?` | `string`[] | A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="initialparameters"></a> `initialParameters?` | [`ParameterValues`](./api/ParameterValues.md) | Initial values for query parameters, slug-keyed. Applied once on mount; user widget edits afterwards are not reflected back to the host. <br/> For each parameter: <br/> - set to a value (string for a single option, array of strings for multiple): that value is applied. <br/> - set to `null`: strictly cleared, ignoring the parameter's default. <br/> - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default). <br/> <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [initialParameters](./api/InteractiveDashboardProps.md#initialparameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="onload"></a> `onLoad?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded. |+| <a id="onloadwithoutcards"></a> `onLoadWithoutCards?` | (`dashboard`: [`MetabaseDashboard`](./api/MetabaseDashboard.md) \| `null`) => `void` | Callback that is called when the dashboard is loaded without cards. |+| <a id="onparameterschange"></a> `onParametersChange?` | (`payload`: [`ParameterChangePayload`](./api/ParameterChangePayload.md)) => `void` | Fires on parameters change. The payload's `source` distinguishes the initial state on load (`'initial-state'`), user edits in the UI (`'manual-change'`), and auto-updates (`'auto-change'`). |+| <a id="onvisualizationchange"></a> `onVisualizationChange?` | (`visualization`: \| `"object"` \| `"table"` \| `"bar"` \| `"line"` \| `"pie"` \| `"scalar"` \| `"row"` \| `"area"` \| `"combo"` \| `"pivot"` \| `"smartscalar"` \| `"gauge"` \| `"progress"` \| `"funnel"` \| `"map"` \| `"scatter"` \| `"boxplot"` \| `"waterfall"` \| `"sankey"` \| `"treemap"` \| `"list"`) => `void` | A callback function that triggers when a question is opened from a dashboard card or when the user changes the visualization type of a question. |+| <a id="parameters"></a> `parameters?` | [`ParameterValues`](./api/ParameterValues.md) | Controlled parameter values, slug-keyed. On every render, this object replaces the dashboard's parameter values: <br/> - a parameter set to a value uses that value. <br/> - a parameter set to `null` is cleared, even if it has a default. <br/> - a parameter omitted from the object (or set to `undefined`) uses its default (or `null` if it has no default). <br/> <br/> Pair with [onParametersChange](./api/InteractiveDashboardProps.md#onparameterschange) to stay in sync with user edits. <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account). <br/> - Combining [parameters](./api/InteractiveDashboardProps.md#parameters) and [hiddenParameters](./api/InteractiveDashboardProps.md#hiddenparameters) to declutter the user interface is fine. |+| <a id="plugins"></a> `plugins?` | [`MetabasePluginsConfig`](./api/MetabasePluginsConfig.md) | Additional mapper function to override or add drill-down menu. See the implementing custom actions section for more details. |+| <a id="style"></a> `style?` | [`CSSProperties`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/0b728411cd1dfb4bd26992bb35a73cf8edaa22e7/types/react/index.d.ts#L2579) | A custom style object to be added to the root element. |+| <a id="token"></a> `token?` | `string` \| `null` | A valid JWT token for the guest embed. |+| <a id="withcardtitle"></a> `withCardTitle?` | `boolean` | Whether the dashboard cards should display a title. |+| <a id="withdownloads"></a> `withDownloads?` | `boolean` | Whether to hide the download button. |+| <a id="withsubscriptions"></a> `withSubscriptions?` | `boolean` | Whether to show the subscriptions button. |+| <a id="withtitle"></a> `withTitle?` | `boolean` | Whether the dashboard should display a title. |<!-- [<endsnippet properties>] -->diff --git a/docs/questions/visualizations/visualizing-results.md b/docs/questions/visualizations/visualizing-results.mdindex 437bd62245c..469a770d5f8 100644--- a/docs/questions/visualizations/visualizing-results.md+++ b/docs/questions/visualizations/visualizing-results.md@@ -193,4 +193,4 @@ See also [Formatting defaults](../../data-modeling/metadata/formatting.md).- [Charts with multiple series](../../dashboards/multiple-series.md)- [Custom visualizations](./custom.md)- [Appearance](../../configuring-metabase/appearance.md)-- [BI dashboard best practices](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/dashboards/bi-dashboard-best-practices.html)+- [BI dashboard best practices](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/dashboards/bi-dashboard-best-practices)diff --git a/docs/troubleshooting-guide/diagnostic-info.md b/docs/troubleshooting-guide/diagnostic-info.mdindex ae5a0c421d0..7c7fd8806d6 100644--- a/docs/troubleshooting-guide/diagnostic-info.md+++ b/docs/troubleshooting-guide/diagnostic-info.md@@ -27,7 +27,7 @@ Metabase will log errors, both on the server and in the browser console, dependi**Checking for Javascript console errors:** Metabase will send debugging information and errors to your browser's developer console. To open the developer console, follow the instructions for your web browser:-- [Chrome](https://developers.google.com/web/tools/chrome-devtools/open#console)+- [Chrome](https://developer.chrome.com/docs/devtools/open)- [Edge](https://learn.microsoft.com/en-us/microsoft-edge/devtools/landing/)- [Firefox](https://firefox-source-docs.mozilla.org/devtools-user/)- [Safari](https://support.apple.com/guide/safari-developer/develop-menu-dev39df999c1/mac)diff --git a/docs/troubleshooting-guide/linked-filters.md b/docs/troubleshooting-guide/linked-filters.mdindex 7e71f45641d..544ef3d41dd 100644--- a/docs/troubleshooting-guide/linked-filters.md+++ b/docs/troubleshooting-guide/linked-filters.md@@ -70,5 +70,5 @@ See [Limitations of linking filters](../dashboards/linked-filters.md#limitations[filter-widget-gloss]: https://www.metabase.com/glossary/filter-widget[foreign-key-gloss]: https://www.metabase.com/glossary/foreign-key[join-types]: https://www.metabase.com/learn/sql/working-with-sql/sql-join-types-[learn-linking]: https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/dashboards/linking-filters.html+[learn-linking]: https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/dashboards/linking-filters[linked-filter-gloss]: https://www.metabase.com/glossary/linked-filterdiff --git a/docs/troubleshooting-guide/my-dashboard-is-slow.md b/docs/troubleshooting-guide/my-dashboard-is-slow.mdindex fc25680a034..b3a296f83fa 100644--- a/docs/troubleshooting-guide/my-dashboard-is-slow.md+++ b/docs/troubleshooting-guide/my-dashboard-is-slow.md@@ -34,7 +34,7 @@ Aside from running faster, a small and focused dashboard is also easier for peopIf you have a dashboard that many people check around the same time (e.g., at the start of the work day), you may end up with queued queries or saturated database connections. Caching allows you to prepare for peak traffic by running those slow queries once, ahead of time, so that the results are ready to go.-Caching takes less effort because it doesn't involve any changes to your schemas or databases. If you're ready to invest more resources into the root cause of dashboard performance issues, check out this list of common [schema and database optimizations](https://metabase.com/learn/metabase-basics/administration/administration-and-operation/making-dashboards-faster#organize-data-to-anticipate-common-questions).+Caching takes less effort because it doesn't involve any changes to your schemas or databases. If you're ready to invest more resources into the root cause of dashboard performance issues, check out this list of common [schema and database optimizations](https://www.metabase.com/learn/metabase-basics/administration/administration-and-operation/making-dashboards-faster#organize-data-to-anticipate-common-questions).## Embedded dashboard is slow compared to original dashboarddiff --git a/docs/troubleshooting-guide/timeout.md b/docs/troubleshooting-guide/timeout.mdindex 8657640ed2d..e39a5ec2bed 100644--- a/docs/troubleshooting-guide/timeout.md+++ b/docs/troubleshooting-guide/timeout.md@@ -19,7 +19,7 @@ Fixes for timeout problems will depend on your specific setup. These resources m- [Jetty connectors][configuring-jetty]- [EC2 Troubleshooting][ec2-troubleshooting]- [Elastic Load Balancing Connection Timeout Management][elb-timeout]-- [App Engine: Dealing with DeadlineExceededErrors][app-engine-timeout]+- [App Engine: Handling request timeouts][app-engine-timeout]## Are you still stuck?@@ -28,7 +28,7 @@ If you can’t solve your problem using the troubleshooting guides:- Search or ask the [Metabase community][discourse].- Search for [known bugs or limitations][known-issues].-[app-engine-timeout]: https://cloud.google.com/appengine/articles/deadlineexceedederrors+[app-engine-timeout]: https://docs.cloud.google.com/appengine/docs/standard/how-requests-are-handled#the_request_timer[configuring-jetty]: https://jetty.org/docs/jetty/12/operations-guide/protocols/index.html[discourse]: https://discourse.metabase.com/[ec2-troubleshooting]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.htmldiff --git a/docs/util/README.md b/docs/util/README.mdindex e0f9d343682..ef506638c0e 100644--- a/docs/util/README.md+++ b/docs/util/README.md@@ -24,18 +24,24 @@ docs/exploration-and-organization/keyboard-shortcuts.md## Check links-Checks every link in the markdown under `docs/`, and every `url` in `data/nav.yml`. A nav url has to point at a page under `docs/`, and if it has an `#anchor`, that heading has to exist in the page. CI runs the same checks in `.github/workflows/docs-links.yml`.+Checks every link in the markdown under `docs/`, every `url` in `data/nav.yml`, and every `https://www.metabase.com/docs/latest/...` link written out in the source code (TSDoc, error messages, emails, docstrings in the frontend, backend and `resources/`) and the root `README.md`. A full `https://www.metabase.com/docs/latest/...` link, in the docs or the source, is checked against the page under `docs/` rather than the live site, even with `--external`. A nav url or source link has to point at a page under `docs/`, and if it has an `#anchor`, that heading has to exist in the page. A link to an old path that only survives as a `redirect_from` fails too. CI runs the same checks in `.github/workflows/docs-links.yml`. Links built with `useDocsUrl` and `getDocsUrl` are checked by `bun run lint-docs-links` instead, which the same workflow runs whenever a PR changes the docs or the frontend.Install [lychee](https://lychee.cli.rs) and jq (`brew install lychee jq`), then run from the repo root:```bash-docs/util/check-links.sh # both+docs/util/check-links.sh # all threedocs/util/check-links.sh docs # only the markdown under docs/docs/util/check-links.sh nav # only nav.yml+docs/util/check-links.sh src # only the source code+docs/util/check-links.sh site # metabase.com and GitHub wiki links against the live sitesdocs/util/check-links.sh --external [nav] # also fetch links to other sites```-By default (and in CI) links to other sites are skipped, so the check is fast and works offline. Run it with `--external` now and then to catch external links that have gone dead. It's slower, and a busy site can answer with a 429, which lychee counts as fine.+`docs/util/check-links.sh site` fetches every `metabase.com` link in the repo from the live site, and fails on a redirect as well as a 404: a link that only works through a redirect breaks silently when the site drops the redirect. It treats links to our GitHub wikis the same way, because a wiki that's been turned off redirects every page to the repo instead of answering 404. It skips `/docs/latest/` links: the live docs are the last release, so they don't have pages added on master since, and the offline checks already cover docs pages, including old paths that only survive under `redirect_from`. If it flags something that isn't a link people follow, like a CSP origin, add it to `site_not_links` in the script.++Both `site` and `--external` need the network, so CI runs them every Sunday (`.github/workflows/docs-links-site.yml`) rather than on every PR. It keeps the broken links in one open "metabase/metabase broken links report" issue in the Growth team's Linear: a failing run opens the issue or updates it, and a passing run closes it. #growth-alerts in Slack hears when the issue opens or closes, and when the check can't run.++By default (and in CI) links to other sites are skipped, so the check is fast and works offline. Run it with `--external` to catch external links that have gone dead. It's slower, and a busy site can answer with a 429, which lychee counts as fine.Some sites can't be checked at all: they block anything that isn't a browser, sit behind a login, or render the page in JavaScript so lychee can't see the `#anchor`. Those are listed under `exclude` in `.lychee/config.toml`, each with a comment saying why. If `--external` flags a link that works in a browser, add it there rather than removing the link.@@ -43,4 +49,4 @@ Broken nav urls are reported as `docs/util/data/nav.yml:LINE`. If a page moved,A url with the wrong capitalization can pass on macOS and still fail in CI, because Linux filenames are case-sensitive.-If you link to a heading that starts with a digit or punctuation, give the heading an explicit `{#id}` first. GitHub and the docs site generate different ids for those headings.+The docs site generates the same heading ids as GitHub, so link to a heading by the id GitHub gives it: ``### 2. Add `MB_API_KEY` `` becomes `#2-add-mb_api_key`. Give a heading an explicit `{#id}` when you want a shorter or more stable one.diff --git a/docs/util/check-links.sh b/docs/util/check-links.shindex b34861853a6..d56fb444fef 100755--- a/docs/util/check-links.sh+++ b/docs/util/check-links.sh@@ -1,14 +1,18 @@#!/usr/bin/env bash-# Checks the docs links: every link in the markdown under docs/, and every `url` in-# docs/util/data/nav.yml (the page has to exist under docs/, and so does any #anchor).+# Checks the docs links: every link in the markdown under docs/, every `url` in+# docs/util/data/nav.yml, and every metabase.com/docs/latest link written out in the source code+# (the page has to exist under docs/, and so does any #anchor).#-# docs/util/check-links.sh # both+# docs/util/check-links.sh # all three# docs/util/check-links.sh docs # only the markdown under docs/# docs/util/check-links.sh nav # only nav.yml+# docs/util/check-links.sh src # only the source code+# docs/util/check-links.sh site # metabase.com and GitHub wiki links against the live sites# docs/util/check-links.sh --external [nav] # also fetch external links (slow, needs network)## Without --external, links to other sites are skipped, which is how CI runs it-# (.github/workflows/docs-links.yml). Needs lychee (https://lychee.cli.rs) and jq.+# (.github/workflows/docs-links.yml). Needs lychee (https://lychee.cli.rs) and jq. Set LINKS_REPORT to a+# file to also collect every failure there (.github/workflows/docs-links-site.yml files it as a Linear issue).set -euo pipefailcd "$(dirname "$0")/../.."@@ -24,22 +28,67 @@ for tool in lychee jq; dodoneexternal=0-what=both+what=allfor arg in "$@"; docase "$arg" in--external) external=1 ;;- docs|nav|both) what=$arg ;;- *) echo "usage: $0 [--external] [docs|nav]" >&2; exit 2 ;;+ docs|nav|src|site) what=$arg ;;+ *) echo "usage: $0 [--external] [docs|nav|src|site]" >&2; exit 2 ;;esacdone-lychee_args=(--config ./.lychee/config.toml)+# Full metabase.com/docs/latest URLs would be skipped offline, and the live /docs/latest is the last release,+# which lacks pages added on master since. So map each one back to its markdown file under docs/. --include+# takes precedence over --offline and the config's excludes, so the API reference drops its #tag/... anchors+# here: Scalar renders them client-side.+docs_latest_args=(--include '^https?://(www\.)?metabase\.com/docs/latest/'+ --remap "^https?://(www\.)?metabase\.com/docs/latest/api(\.html)?(#.*)?\$ file://$PWD/docs/api.html"+ --remap "^https?://(www\.)?metabase\.com/docs/latest/([^#?]+?)(\.html)?(\?[^#]*)?(#.*)?\$ file://$PWD/docs/\$2.md\$5")+lychee_args=(--config ./.lychee/config.toml "${docs_latest_args[@]}")[ "$external" -eq 1 ] || lychee_args+=(--offline)-# Same arguments as the "Run link checker" step in CI (plus --offline there).+# Prints each failure in lychee's JSON report ($1) as "path:line: url: status", with a GitHub annotation in+# CI, and appends it to $LINKS_REPORT when that's set. Checks that render their urls into a temporary file+# pass $2, which holds the real path:line for each line of that file. Sets `total` and `count`.+# lychee exits 2 when links fail but still prints the report. It also exits 2 on a bad flag and prints+# nothing, so trust the report, not the exit code.+print_failures() {+ local report=$1 locations=${2:-} file line url text location+ total=$(jq -e -r '.total' <<<"$report") || {+ echo "lychee produced no report (see errors above)" >&2+ return 1+ }+ count=0+ while IFS=$'\t' read -r file line url text; do+ [ -n "$line" ] || continue+ count=$((count + 1))+ if [ -n "$locations" ]; then+ location=$(sed -n "${line}p" "$locations" | cut -d: -f1,2)+ else+ location=$file:$line+ fi+ url=${url#file://$PWD/docs/}+ echo "$location: $url: $text"+ if [ -n "${LINKS_REPORT:-}" ]; then+ echo "$location: $url: $text" >> "$LINKS_REPORT"+ fi+ if [ -n "${GITHUB_ACTIONS:-}" ]; then+ echo "::error file=${location%:*},line=${location##*:}::$url: $text"+ fi+ # lychee reports a url it already checked as "Error (cached)", so reuse the first status for it.+ done < <(jq -r '[.error_map | to_entries[] | .key as $file | .value[]+ | {$file, line: .span.line, url, text: .status.text}] as $failures+ | ($failures | map(select(.text | test("cached") | not)) | INDEX(.url)) as $first+ | $failures[] | "\(.file)\t\(.line)\t\(.url)\t\($first[.url].text // .text)"' <<<"$report")+}+check_docs() {echo "Checking links in docs/"- lychee docs "${lychee_args[@]}"+ local report total count+ report=$(lychee docs "${lychee_args[@]}" --no-progress --format json || true)+ print_failures "$report" || return 1+ echo "Checked $total links in docs/, $count broken"+ [ "$count" -eq 0 ]}# lychee can't read YAML, so render the nav as markdown with one line per nav.yml line: a link on@@ -48,12 +97,13 @@ check_docs() {# docs/) are only rendered when checking external links.check_nav() {echo "Checking urls in $nav"- local root tmpdir rendered report failures total count line url text+ local root tmpdir rendered locations report total countroot=$PWD/docstmpdir=$(mktemp -d)trap 'rm -rf "$tmpdir"' RETURN# The .md extension matters: lychee only looks for markdown links in markdown files.rendered=$tmpdir/nav-links.md+ locations=$tmpdir/locationsawk -v external="$external" -v site="$site" 'match($0, /^[[:space:]]*(- )?url:[[:space:]]*/) {@@ -65,37 +115,92 @@ check_nav() {}{ print "" }' "$nav" > "$rendered"+ awk -v nav="$nav" '{ print nav ":" NR }' "$nav" > "$locations"- # lychee exits 2 when links fail but still prints the report. It also exits 2 on a bad flag and- # prints nothing, so trust the report, not the exit code.report=$(lychee "${lychee_args[@]}" --root-dir "$root" --fallback-extensions md,html \--include-fragments --no-progress --format json "$rendered" || true)- total=$(jq -e -r '.total' <<<"$report") || {- echo "lychee produced no report (see errors above)" >&2- return 1- }+ print_failures "$report" "$locations" || return 1+ echo "Checked $total nav urls, $count broken"+ [ "$count" -eq 0 ]+}- failures=$(jq -r '.error_map[][] | "\(.span.line)\t\(.url)\t\(.status.text)"' <<<"$report")+# Full metabase.com/docs URLs in the source code (TSDoc, error messages, emails, docstrings), mapped back to+# docs/ like the ones in docs/. git grep pulls the URLs out first because lychee can't parse every string+# in source code as a URL (postgres://user:pw@host:port).+# Links built with useDocsUrl/getDocsUrl aren't literal URLs, so bin/verify-doc-links checks those. Unit+# specs only repeat what those helpers return, and resources/openapi is generated from src docstrings.+check_src() {+ echo "Checking docs links in the source code"+ local tmpdir locations rendered report total count+ tmpdir=$(mktemp -d)+ trap 'rm -rf "$tmpdir"' RETURN+ locations=$tmpdir/locations+ # The .md extension matters: lychee only looks for markdown links in markdown files.+ rendered=$tmpdir/src-links.md- count=0- while IFS=$'\t' read -r line url text; do- [ -n "$line" ] || continue- count=$((count + 1))- url=${url#file://$root/}- echo "$nav:$line: $url: $text"- if [ -n "${GITHUB_ACTIONS:-}" ]; then- echo "::error file=$nav,line=$line::$url: $text"- fi- done <<<"$failures"+ # path:line:url, one per line. Urls built with ${...} can't be checked, and trailing punctuation is+ # usually the end of a sentence in a docstring.+ git grep -nIoE 'https?://(www\.)?metabase\.com/docs/latest/[^][:space:]"'"'"'`<>()\\]*' \+ -- frontend/src enterprise/frontend/src src enterprise/backend/src resources modules \+ .github/ISSUE_TEMPLATE README.md ':!*.unit.spec.*' ':!resources/openapi' |+ grep -v '\${' | sed -E 's/[.,;:]+$//' > "$locations" || true+ sed -E 's/^[^:]+:[0-9]+:(.*)$/- [src](\1)/' "$locations" > "$rendered"- echo "Checked $total nav urls, $count broken"+ report=$(lychee --config ./.lychee/config.toml --offline --include-fragments=full --no-progress \+ --format json "${docs_latest_args[@]}" "$rendered" || true)+ print_failures "$report" "$locations" || return 1+ echo "Checked $total docs links in the source code, $count broken"[ "$count" -eq 0 ]}+# The offline checks only see pages under docs/. The rest of metabase.com (/learn, /product, /cloud, and+# redirects the site sets up itself) can only be checked live, so this fetches every metabase.com url in+# the repo and fails on a redirect as well as a 404: a link that works only through a redirect breaks+# silently when the site drops the redirect. Our GitHub wikis get the same treatment, because a wiki+# that's been turned off redirects every page to the repo instead of answering 404. Too slow and too+# dependent on the sites for every PR, so CI runs it weekly (.github/workflows/docs-links-site.yml).+check_site() {+ echo "Checking metabase.com and GitHub wiki links against the live sites"+ local tmpdir locations rendered report total count+ tmpdir=$(mktemp -d)+ trap 'rm -rf "$tmpdir"' RETURN+ locations=$tmpdir/locations+ rendered=$tmpdir/site-links.md++ git grep -nIoE 'https?://(www\.)?metabase\.com(/[^][:space:]"'"'"'`<>()\\|]*)?|https://github\.com/metabase/[^/[:space:]]+/wiki(/[^][:space:]"`<>()\\|]*)?' \+ -- docs frontend/src enterprise/frontend/src src enterprise/backend/src resources modules \+ .github/ISSUE_TEMPLATE README.md ':!*.unit.spec.*' ':!resources/openapi' ':!docs/embedding/sdk/api' ':!docs/api.json' |+ grep -v -e '\${' -e '{{' -e '{%' | sed -E "s/[.,;:']+\$//" > "$locations" || true+ sed -E 's/^[^:]+:[0-9]+:(.*)$/- [site](\1)/' "$locations" > "$rendered"++ report=$(lychee --no-progress --format json --max-redirects 0 --max-concurrency 8 --max-retries 3 \+ --timeout 30 --accept '200..=204,429' \+ "${site_not_links[@]/#/--exclude=}" "$rendered" || true)+ print_failures "$report" "$locations" || return 1+ echo "Checked $total metabase.com and GitHub wiki links, $count broken or redirected"+ [ "$count" -eq 0 ]+}++# Urls the live check skips, as regexes for lychee's --exclude: strings that look like metabase.com links+# but aren't followed by anyone, and docs pages the offline checks cover. Fix a real link instead of adding+# it here.+site_not_links=(+ # The live /docs/latest is the last release, so pages added or moved on master since then redirect or 404.+ '^https?://(www\.)?metabase\.com/docs/latest/'+ # Bare metabase.com: CSP origins, the OpenRouter attribution header, a dummy host for parsing paths.+ '^https?://metabase\.com/?$'+ # VersionUpdateNotice appends the version to this.+ '^https://www\.metabase\.com/docs/$'+ # Example data in the regexextract docs.+ 'utm_campaign=(alice|neo)$'+)+status=0case "$what" in- both) check_docs || status=1; echo; check_nav || status=1 ;;+ all) check_docs || status=1; echo; check_nav || status=1; echo; check_src || status=1 ;;docs) check_docs || status=1 ;;nav) check_nav || status=1 ;;+ src) check_src || status=1 ;;+ site) check_site || status=1 ;;esacexit "$status"diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-flow-enable-embed-js.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-flow-enable-embed-js.cy.spec.tsindex 9d4341a778d..de31c99ede3 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-flow-enable-embed-js.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding-setup/embed-flow-enable-embed-js.cy.spec.ts@@ -206,7 +206,7 @@ describe("scenarios > embedding > sdk iframe embed setup > enable embed js (oss.should("have.attr","href",- "https://metabase.com/license/embedding",+ "https://www.metabase.com/license/embedding",).should("have.attr", "target", "_blank");@@ -244,7 +244,7 @@ describe("scenarios > embedding > sdk iframe embed setup > enable embed js (oss.should("have.attr","href",- "https://metabase.com/license/embedding",+ "https://www.metabase.com/license/embedding",).should("have.attr", "target", "_blank");});diff --git a/enterprise/frontend/src/embedding-sdk-package/README.md b/enterprise/frontend/src/embedding-sdk-package/README.mdindex 53f571b2b18..e2ec8a8e905 100644--- a/enterprise/frontend/src/embedding-sdk-package/README.md+++ b/enterprise/frontend/src/embedding-sdk-package/README.md@@ -16,7 +16,7 @@ Just some commands to get you started. For more on how to set up the SDK with yo### Installing Metabase-Start a free trial of [Metabase Pro](https://www.metabase.com/pricing/).+Start a free trial of [Metabase Pro](https://www.metabase.com/pricing).Or run it locally. Here's a docker one-liner:diff --git a/enterprise/frontend/src/embedding-sdk-package/cli/snippets/theme-switcher-snippet.ts b/enterprise/frontend/src/embedding-sdk-package/cli/snippets/theme-switcher-snippet.tsindex 08dd0145094..93937278e1e 100644--- a/enterprise/frontend/src/embedding-sdk-package/cli/snippets/theme-switcher-snippet.ts+++ b/enterprise/frontend/src/embedding-sdk-package/cli/snippets/theme-switcher-snippet.ts@@ -6,7 +6,7 @@ import { AnalyticsContext } from './analytics-provider'// Demo component to switch between light and dark themes, for testing out themes.// In a real app, this would be implemented by your application.-// See https://www.metabase.com/docs/latest/embedding/sdk/appearance+// See https://www.metabase.com/docs/latest/embedding/appearanceexport const ThemeSwitcher = () => {const { themeKey, setThemeKey } = useContext(AnalyticsContext)diff --git a/enterprise/frontend/src/embedding-sdk-package/cli/snippets/user-switcher-snippet.ts b/enterprise/frontend/src/embedding-sdk-package/cli/snippets/user-switcher-snippet.tsindex bfa9343e610..af064feb854 100644--- a/enterprise/frontend/src/embedding-sdk-package/cli/snippets/user-switcher-snippet.ts+++ b/enterprise/frontend/src/embedding-sdk-package/cli/snippets/user-switcher-snippet.ts@@ -16,7 +16,7 @@ const USERS = ${JSON.stringify(users, null, 2)}// Demo component to switch between fake users.// In a real app, this would be managed by your auth provider.-// See https://www.metabase.com/docs/latest/embedding/sdk/authentication+// See https://www.metabase.com/docs/latest/embedding/authenticationexport const UserSwitcher = () => {const {email, switchUser} = useContext(AnalyticsContext)diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkUsageProblem/SdkUsageProblemDisplay.unit.spec.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkUsageProblem/SdkUsageProblemDisplay.unit.spec.tsxindex 4f7f9f5f92e..779459c9def 100644--- a/frontend/src/embedding-sdk-bundle/components/private/SdkUsageProblem/SdkUsageProblemDisplay.unit.spec.tsx+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkUsageProblem/SdkUsageProblemDisplay.unit.spec.tsx@@ -170,7 +170,7 @@ describe("SdkUsageProblemDisplay", () => {expect(docsLink).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/sdk/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication",+ "https://www.metabase.com/docs/latest/embedding/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication",);});@@ -273,7 +273,7 @@ describe("SdkUsageProblemDisplay", () => {expect(docsLink).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/sdk/introduction#in-metabase",+ "https://www.metabase.com/docs/latest/embedding/sdk/introduction#enable-the-sdk-in-metabase",);mock.mockRestore();@@ -338,7 +338,7 @@ describe("SdkUsageProblemDisplay", () => {expect(docsLink).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/sdk/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication",+ "https://www.metabase.com/docs/latest/embedding/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication",);});diff --git a/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx b/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsxindex c2be1f3c23b..ee6aaad6a1d 100644--- a/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx+++ b/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx@@ -181,7 +181,7 @@ export type SdkDashboardProps = PropsWithChildren<* - omitted (or set to `undefined`): falls back to the parameter's default (or `null` if it has no default).* <br/>* <br/>- * - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account).+ * - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).* <br/>* - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to declutter the user interface is fine.*/@@ -199,7 +199,7 @@ export type SdkDashboardProps = PropsWithChildren<* <br/>* Pair with {@link SdkDashboardProps.onParametersChange | onParametersChange} to stay in sync with user edits.* <br/>- * - Combining {@link SdkDashboardProps.parameters | parameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account).+ * - Combining {@link SdkDashboardProps.parameters | parameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).* <br/>* - Combining {@link SdkDashboardProps.parameters | parameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to declutter the user interface is fine.*/diff --git a/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-dashboard-params.ts b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-dashboard-params.tsindex 97f93c71db7..7da25933576 100644--- a/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-dashboard-params.ts+++ b/frontend/src/embedding-sdk-bundle/hooks/private/use-sdk-dashboard-params.ts@@ -20,7 +20,7 @@ export type SdkDashboardDisplayProps = SdkDashboardEntityInternalProps & {/*** Query parameters for the dashboard. For a single option, use a `string` value, and use a list of strings for multiple options.* <br/>- * - Combining {@link SdkDashboardDisplayProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account).+ * - Combining {@link SdkDashboardDisplayProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).* <br/>* - Combining {@link SdkDashboardDisplayProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to declutter the user interface is fine.*/@@ -47,9 +47,9 @@ export type SdkDashboardDisplayProps = SdkDashboardEntityInternalProps & {withSubscriptions?: boolean;/**- * A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links.html#appearance-parameters).+ * A list of [parameters to hide](https://www.metabase.com/docs/latest/embedding/public-links#appearance-parameters).* <br/>- * - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/sdk/authentication.html#security-warning-each-end-user-must-have-their-own-metabase-account).+ * - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to filter data on the frontend is a [security risk](https://www.metabase.com/docs/latest/embedding/authentication#security-warning-each-end-user-must-have-their-own-metabase-account).* <br/>* - Combining {@link SdkDashboardProps.initialParameters | initialParameters} and {@link SdkDashboardDisplayProps.hiddenParameters | hiddenParameters} to declutter the user interface is fine.**/diff --git a/frontend/src/embedding-sdk-bundle/lib/usage-problem.ts b/frontend/src/embedding-sdk-bundle/lib/usage-problem.tsindex 05dedcfe86e..82dd8d126c2 100644--- a/frontend/src/embedding-sdk-bundle/lib/usage-problem.ts+++ b/frontend/src/embedding-sdk-bundle/lib/usage-problem.ts@@ -49,13 +49,13 @@ export const USAGE_PROBLEM_MESSAGES = {export const SDK_AUTH_DOCS_URL =// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- these links are used in the SDK banner which is only shown to developers- "https://www.metabase.com/docs/latest/embedding/sdk/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication";+ "https://www.metabase.com/docs/latest/embedding/authentication#2-add-a-new-endpoint-to-your-backend-to-handle-authentication";export const METABASE_UPGRADE_URL = "https://www.metabase.com/upgrade";export const SDK_INTRODUCTION_DOCS_URL =// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- these links are used in the SDK banner which is only shown to developers- "https://www.metabase.com/docs/latest/embedding/sdk/introduction#in-metabase";+ "https://www.metabase.com/docs/latest/embedding/sdk/introduction#enable-the-sdk-in-metabase";const SDK_PREREQUISITES_DOCS_URL =// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- these links are used in the SDK banner which is only shown to developersdiff --git a/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts b/frontend/src/embedding-sdk-bundle/types/metabase-provider.tsindex 5abe56b09f8..23ab7206173 100644--- a/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts+++ b/frontend/src/embedding-sdk-bundle/types/metabase-provider.ts@@ -30,7 +30,7 @@ export interface MetabaseProviderProps {authConfig: MetabaseAuthConfig;/**- * See [Appearance](https://www.metabase.com/docs/latest/embedding/sdk/appearance).+ * See [Appearance](https://www.metabase.com/docs/latest/embedding/appearance).*/theme?: MetabaseEmbeddingTheme;diff --git a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/Description/Description.tsx b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/Description/Description.tsxindex fd2e5cfb0f0..7f79693c873 100644--- a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/Description/Description.tsx+++ b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/Description/Description.tsx@@ -8,7 +8,7 @@ import { Text } from "metabase/ui";export function Description() {const docsLink = useSelector((state) =>- getDocsUrl(state, { page: "actions/custom" }),+ getDocsUrl(state, { page: "data-modeling/models/actions/custom" }),);const showMetabaseLinks = useSelector(getShowMetabaseLinks);diff --git a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/EmptyFormPlaceholder/EmptyFormPlaceholder.tsx b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/EmptyFormPlaceholder/EmptyFormPlaceholder.tsxindex 2bf16e39abc..113e5268893 100644--- a/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/EmptyFormPlaceholder/EmptyFormPlaceholder.tsx+++ b/frontend/src/metabase/actions/containers/ActionCreator/FormCreator/EmptyFormPlaceholder/EmptyFormPlaceholder.tsx@@ -7,7 +7,9 @@ import { Box, Icon, Stack, Text, Title } from "metabase/ui";import S from "./EmptyFormPlaceholder.module.css";export const EmptyFormPlaceholder = () => {- const { url, showMetabaseLinks } = useDocsUrl("actions/custom");+ const { url, showMetabaseLinks } = useDocsUrl(+ "data-modeling/models/actions/custom",+ );return (<Stack justify="center" h="100%" p="3rem" gap={0}>diff --git a/frontend/src/metabase/admin/ai/MetabotSlackSetup.tsx b/frontend/src/metabase/admin/ai/MetabotSlackSetup.tsxindex 8fb2d68a1e2..3c4f5f1d535 100644--- a/frontend/src/metabase/admin/ai/MetabotSlackSetup.tsx+++ b/frontend/src/metabase/admin/ai/MetabotSlackSetup.tsx@@ -175,7 +175,7 @@ export function MetabotSlackSetup() {}, [notification]);const { url: encryptionDocsUrl } = useDocsUrl(- "operations-guide/encrypting-database-details-at-rest",+ "databases/encrypting-details-at-rest",);if (!isSlackTokenValid) {diff --git a/frontend/src/metabase/admin/ai/MetabotSlackSetup.unit.spec.tsx b/frontend/src/metabase/admin/ai/MetabotSlackSetup.unit.spec.tsxindex 7d494935909..f7699456a2d 100644--- a/frontend/src/metabase/admin/ai/MetabotSlackSetup.unit.spec.tsx+++ b/frontend/src/metabase/admin/ai/MetabotSlackSetup.unit.spec.tsx@@ -159,7 +159,7 @@ describe("MetabotSlackSetup", () => {screen.getByRole("link", { name: "Learn how to enable encryption" }),).toHaveAttribute("href",- expect.stringContaining("encrypting-database-details-at-rest"),+ expect.stringContaining("databases/encrypting-details-at-rest"),);expect(screen.queryByLabelText("Client ID")).not.toBeInTheDocument();diff --git a/frontend/src/metabase/admin/databases/components/DatabaseModelPersistenceSection/ModelCachingControl/ModelCachingControl.tsx b/frontend/src/metabase/admin/databases/components/DatabaseModelPersistenceSection/ModelCachingControl/ModelCachingControl.tsxindex 4432cb50592..631bed651c1 100644--- a/frontend/src/metabase/admin/databases/components/DatabaseModelPersistenceSection/ModelCachingControl/ModelCachingControl.tsx+++ b/frontend/src/metabase/admin/databases/components/DatabaseModelPersistenceSection/ModelCachingControl/ModelCachingControl.tsx@@ -54,7 +54,7 @@ export function ModelCachingControl({ database, disabled }: Props) {}};- const { url: docsUrl } = useDocsUrl("data-modeling/model-persistence");+ const { url: docsUrl } = useDocsUrl("data-modeling/models/model-persistence");return (<div>diff --git a/frontend/src/metabase/admin/help/Help.tsx b/frontend/src/metabase/admin/help/Help.tsxindex 1a90d8b3e07..54d91c51d8e 100644--- a/frontend/src/metabase/admin/help/Help.tsx+++ b/frontend/src/metabase/admin/help/Help.tsx@@ -38,7 +38,7 @@ const template = `**Describe the bug**A clear and concise description of what the bug is.**Logs**-Please include javascript console and server logs around the time this bug occurred. For information about how to get these, consult our [bug troubleshooting guide](https://metabase.com/docs/latest/troubleshooting-guide/bugs.html)+Please include javascript console and server logs around the time this bug occurred. For information about how to get these, consult our [bug troubleshooting guide](https://www.metabase.com/docs/latest/troubleshooting-guide/bugs)**To Reproduce**Steps to reproduce the behavior:diff --git a/frontend/src/metabase/admin/performance/components/ModelPersistenceConfiguration.tsx b/frontend/src/metabase/admin/performance/components/ModelPersistenceConfiguration.tsxindex 01b3f0b3fdc..3d2499e9dc4 100644--- a/frontend/src/metabase/admin/performance/components/ModelPersistenceConfiguration.tsx+++ b/frontend/src/metabase/admin/performance/components/ModelPersistenceConfiguration.tsx@@ -117,7 +117,7 @@ export const ModelPersistenceConfiguration = () => {await resolveWithToasts([promise]);};- const { url: docsUrl } = useDocsUrl("data-modeling/model-persistence");+ const { url: docsUrl } = useDocsUrl("data-modeling/models/model-persistence");return (<PerformancePageContent>diff --git a/frontend/src/metabase/admin/settings/auth/components/GoogleAuthForm/GoogleAuthForm.tsx b/frontend/src/metabase/admin/settings/auth/components/GoogleAuthForm/GoogleAuthForm.tsxindex b90a658bb1e..3b705db98d8 100644--- a/frontend/src/metabase/admin/settings/auth/components/GoogleAuthForm/GoogleAuthForm.tsx+++ b/frontend/src/metabase/admin/settings/auth/components/GoogleAuthForm/GoogleAuthForm.tsx@@ -54,7 +54,7 @@ export const GoogleAuthForm = (): JSX.Element => {return { ...values, [ENABLED_KEY]: true };}, [settingValues]);- const { url: docsUrl } = useDocsUrl("people-and-groups/google-and-ldap", {+ const { url: docsUrl } = useDocsUrl("people-and-groups/google-sign-in", {anchor: "enabling-google-sign-in",});diff --git a/frontend/src/metabase/admin/settings/components/CloudPanel/MigrationStart.tsx b/frontend/src/metabase/admin/settings/components/CloudPanel/MigrationStart.tsxindex babca098717..7865b437527 100644--- a/frontend/src/metabase/admin/settings/components/CloudPanel/MigrationStart.tsx+++ b/frontend/src/metabase/admin/settings/components/CloudPanel/MigrationStart.tsx@@ -35,7 +35,7 @@ export const MigrationStart = ({<Text c="text-secondary">{t`Just a heads up: your Metabase will be read-only for up to 30minutes while we prep it for migration.`}{" "}- <ExternalLink href="https://www.metabase.com/cloud/">{t`Learn More.`}</ExternalLink>+ <ExternalLink href="https://www.metabase.com/cloud">{t`Learn More.`}</ExternalLink></Text><Modal.Footer><Buttondiff --git a/frontend/src/metabase/admin/settings/components/widgets/Notifications/WebhookForm.tsx b/frontend/src/metabase/admin/settings/components/widgets/Notifications/WebhookForm.tsxindex 7826da8ccac..cb5ed8e2103 100644--- a/frontend/src/metabase/admin/settings/components/widgets/Notifications/WebhookForm.tsx+++ b/frontend/src/metabase/admin/settings/components/widgets/Notifications/WebhookForm.tsx@@ -199,7 +199,7 @@ export const WebhookForm = ({}, [error]);const docsUrl = useSelector((state) =>- getDocsUrl(state, { page: "questions/sharing/alerts" }),+ getDocsUrl(state, { page: "questions/alerts" }),);const handleTest = async (diff --git a/frontend/src/metabase/admin/upsells/UpsellRemoteSync.tsx b/frontend/src/metabase/admin/upsells/UpsellRemoteSync.tsxindex 03ffdcd0bc5..d1c6f5674e4 100644--- a/frontend/src/metabase/admin/upsells/UpsellRemoteSync.tsx+++ b/frontend/src/metabase/admin/upsells/UpsellRemoteSync.tsx@@ -5,7 +5,7 @@ import { ExternalLink } from "metabase/common/components/ExternalLink";import { UpsellBigCard } from "metabase/common/components/upsells/components";import S from "metabase/common/components/upsells/components/Upsells.module.css";import { UPGRADE_URL } from "metabase/common/components/upsells/constants";-import { useHasTokenFeature } from "metabase/common/hooks";+import { useDocsUrl, useHasTokenFeature } from "metabase/common/hooks";import { PLUGIN_ADMIN_SETTINGS } from "metabase/plugins";import { useSelector } from "metabase/redux";import { getApplicationName } from "metabase/selectors/whitelabel";@@ -21,6 +21,9 @@ export const UpsellRemoteSync = ({ source }: { source: string }) => {campaign,location: source,});+ const { url: remoteSyncDocsUrl } = useDocsUrl(+ "installation-and-operation/remote-sync",+ );if (hasRemoteSync || isPro) {return null;@@ -37,10 +40,7 @@ export const UpsellRemoteSync = ({ source }: { source: string }) => {illustrationSrc={upsellRemoteSyncImage}>{t`Keep your most important datasets, metrics, and SQL logic under version control. Sync content to a Git repository to review changes, collaborate, and maintain a production-ready source of truth.`}- <ExternalLink- className={S.SecondaryCTALink}- href="https://www.metabase.com/product/git-sync"- >+ <ExternalLink className={S.SecondaryCTALink} href={remoteSyncDocsUrl}>{t`Learn more`}</ExternalLink></UpsellBigCard>diff --git a/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx b/frontend/src/metabase/browse/metrics/BrowseMetrics.tsxindex 6f087dd165a..11e410cfbcb 100644--- a/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx+++ b/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx@@ -152,7 +152,7 @@ function MetricsEmptyState({newMetricLink: string;}) {const { url: metricsDocsLink, showMetabaseLinks } = useDocsUrl(- "data-modeling/metrics",+ "data-modeling/semantic-layer/metrics",);return (diff --git a/frontend/src/metabase/browse/models/BrowseModels.tsx b/frontend/src/metabase/browse/models/BrowseModels.tsxindex eda27cf75f4..42d7f57f48b 100644--- a/frontend/src/metabase/browse/models/BrowseModels.tsx+++ b/frontend/src/metabase/browse/models/BrowseModels.tsx@@ -52,7 +52,7 @@ export const BrowseModels = () => {const { isLoading, error, models, recentModels, hasVerifiedModels } =useFilteredModels(modelFilters);- const { showMetabaseLinks, url } = useDocsUrl("data-modeling/models");+ const { showMetabaseLinks, url } = useDocsUrl("data-modeling/models/models");const isEmpty = !isLoading && !error && models.length === 0;const titleId = useMemo(() => _.uniqueId("browse-models"), []);diff --git a/frontend/src/metabase/browse/models/BrowseModels.unit.spec.tsx b/frontend/src/metabase/browse/models/BrowseModels.unit.spec.tsxindex 973944794b8..d6c36aae97c 100644--- a/frontend/src/metabase/browse/models/BrowseModels.unit.spec.tsx+++ b/frontend/src/metabase/browse/models/BrowseModels.unit.spec.tsx@@ -325,7 +325,7 @@ describe("BrowseModels", () => {await within(emptyState).findByRole("link", { name: "Read the docs" }),).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/data-modeling/models.html",+ "https://www.metabase.com/docs/latest/data-modeling/models/models.html",);});@@ -376,7 +376,7 @@ describe("BrowseModels", () => {await within(banner).findByRole("link", { name: "Read the docs" }),).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/data-modeling/models.html",+ "https://www.metabase.com/docs/latest/data-modeling/models/models.html",);const dismissButton = await within(banner).findByRole("button", {diff --git a/frontend/src/metabase/browse/models/ModelExplanationBanner.tsx b/frontend/src/metabase/browse/models/ModelExplanationBanner.tsxindex bf283e99ea4..597ce38f253 100644--- a/frontend/src/metabase/browse/models/ModelExplanationBanner.tsx+++ b/frontend/src/metabase/browse/models/ModelExplanationBanner.tsx@@ -15,7 +15,7 @@ export const ModelExplanationBanner = () => {const [opened, setOpened] = useState(false);- const { showMetabaseLinks, url } = useDocsUrl("data-modeling/models");+ const { showMetabaseLinks, url } = useDocsUrl("data-modeling/models/models");const dismissBanner = () => {setHasDismissedBanner(true);diff --git a/frontend/src/metabase/common/components/upsells/components/UpsellBanner.stories.tsx b/frontend/src/metabase/common/components/upsells/components/UpsellBanner.stories.tsxindex 988e55fddc9..d5a7f71fd5b 100644--- a/frontend/src/metabase/common/components/upsells/components/UpsellBanner.stories.tsx+++ b/frontend/src/metabase/common/components/upsells/components/UpsellBanner.stories.tsx@@ -59,7 +59,7 @@ const SecondaryTemplate = ({ children, ...args }: UpsellBannerProps) => ({children}<ExternalLinkclassName={S.SecondaryCTALink}- href="https://www.metabase.com/docs"+ href="https://www.metabase.com/docs/latest/">Learn more</ExternalLink>diff --git a/frontend/src/metabase/common/components/upsells/components/UpsellBigCard.stories.tsx b/frontend/src/metabase/common/components/upsells/components/UpsellBigCard.stories.tsxindex ace5c0f2601..c570f345e72 100644--- a/frontend/src/metabase/common/components/upsells/components/UpsellBigCard.stories.tsx+++ b/frontend/src/metabase/common/components/upsells/components/UpsellBigCard.stories.tsx@@ -55,7 +55,7 @@ const SecondaryTemplate = ({{children}<ExternalLinkclassName={S.SecondaryCTALink}- href="https://www.metabase.com/docs"+ href="https://www.metabase.com/docs/latest/">Learn more</ExternalLink>@@ -83,7 +83,7 @@ const ModalTemplate = ({{children}<ExternalLinkclassName={S.SecondaryCTALink}- href="https://www.metabase.com/docs"+ href="https://www.metabase.com/docs/latest/">Learn more</ExternalLink>diff --git a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/LookAndFeelSettings.tsx b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/LookAndFeelSettings.tsxindex 40ea5dafbbe..277a9b849f0 100644--- a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/LookAndFeelSettings.tsx+++ b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/LookAndFeelSettings.tsx@@ -58,8 +58,8 @@ export const LookAndFeelSettings = ({onChangeDisplayOptions,}: AppearanceSettingsProps): JSX.Element => {// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Only appear to admins- const { url: docsUrl } = useDocsUrl("embedding/static-embedding", {- anchor: "customizing-the-appearance-of-static-embeds",+ const { url: docsUrl } = useDocsUrl("embedding/guest-embedding", {+ anchor: "customizing-appearance-of-guest-embeds",utm: {utm_source: "product",utm_medium: "docs",diff --git a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/OverviewSettings.tsx b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/OverviewSettings.tsxindex ceaf3e5acab..5c0688a2d06 100644--- a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/OverviewSettings.tsx+++ b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/OverviewSettings.tsx@@ -38,7 +38,7 @@ export const OverviewSettings = ({);// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- This links only shows for admins.- const { url: docsUrl } = useDocsUrl("embedding/static-embedding", {+ const { url: docsUrl } = useDocsUrl("embedding/guest-embedding", {utm: {utm_source: "product",utm_medium: "docs",diff --git a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/common.unit.spec.tsx b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/common.unit.spec.tsxindex 97adf5cf460..ff56f45613c 100644--- a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/common.unit.spec.tsx+++ b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/common.unit.spec.tsx@@ -100,7 +100,7 @@ describe("Static Embed Setup phase", () => {expect(link).toBeVisible();expect(link).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/static-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-overview&source_plan=oss",+ "https://www.metabase.com/docs/latest/embedding/guest-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-overview&source_plan=oss",);expect(@@ -397,7 +397,7 @@ describe("Static Embed Setup phase", () => {expect(link).toBeVisible();expect(link).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/static-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-look-and-feel&source_plan=oss#customizing-the-appearance-of-static-embeds",+ "https://www.metabase.com/docs/latest/embedding/guest-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-look-and-feel&source_plan=oss#customizing-appearance-of-guest-embeds",);});diff --git a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/premium.unit.spec.tsx b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/premium.unit.spec.tsxindex 208f0619931..6cb14346a09 100644--- a/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/premium.unit.spec.tsx+++ b/frontend/src/metabase/embedding/components/EmbedModal/StaticEmbedSetupPane/tests/premium.unit.spec.tsx@@ -34,7 +34,7 @@ describe("Static Embed Setup phase - EE, with token", () => {expect(link).toBeVisible();expect(link).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/static-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-overview&source_plan=pro-self-hosted",+ "https://www.metabase.com/docs/latest/embedding/guest-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-overview&source_plan=pro-self-hosted",);});});@@ -102,7 +102,7 @@ describe("Static Embed Setup phase - EE, with token", () => {expect(link).toBeVisible();expect(link).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/static-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-look-and-feel&source_plan=pro-self-hosted#customizing-the-appearance-of-static-embeds",+ "https://www.metabase.com/docs/latest/embedding/guest-embedding.html?utm_source=product&utm_medium=docs&utm_campaign=embedding-static&utm_content=static-embed-settings-look-and-feel&source_plan=pro-self-hosted#customizing-appearance-of-guest-embeds",);});diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/AuthenticationCard/EnableGuestEmbedsSection.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/AuthenticationCard/EnableGuestEmbedsSection.tsxindex 2a2fdc0752c..a5b9327b047 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/AuthenticationCard/EnableGuestEmbedsSection.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/AuthenticationCard/EnableGuestEmbedsSection.tsx@@ -61,7 +61,7 @@ export const EnableGuestEmbedsSection = ({const usageConditionsLink = (<Anchorkey="usage-conditions"- href="https://metabase.com/license/embedding"+ href="https://www.metabase.com/license/embedding"target="_blank">{t`usage conditions`}diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/Common/SetupSsoAlert.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/Common/SetupSsoAlert.tsxindex 895eaa724be..e9738171cc6 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/Common/SetupSsoAlert.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/Common/SetupSsoAlert.tsx@@ -14,7 +14,7 @@ const utmTags = {export const SetupSsoAlert = () => {// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Only for admins- const { url: setupSsoUrl } = useDocsUrl("embedding/sdk/authentication", {+ const { url: setupSsoUrl } = useDocsUrl("embedding/authentication", {utm: utmTags,});diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/steps/GetCodeStep/MetabaseAccountCard.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/steps/GetCodeStep/MetabaseAccountCard.tsxindex 9f11ac8e23f..3986dc42dd3 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/steps/GetCodeStep/MetabaseAccountCard.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/steps/GetCodeStep/MetabaseAccountCard.tsx@@ -21,7 +21,7 @@ export const MetabaseAccountCard = () => {const isGuestEmbed = !!settings.isGuest;// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Only for admins- const { url: setupSsoUrl } = useDocsUrl("embedding/sdk/authentication", {+ const { url: setupSsoUrl } = useDocsUrl("embedding/authentication", {utm: utmTags,});diff --git a/frontend/src/metabase/embedding/settings/EmbeddingSecuritySettings/EmbeddingAppSameSiteCookieDescription.tsx b/frontend/src/metabase/embedding/settings/EmbeddingSecuritySettings/EmbeddingAppSameSiteCookieDescription.tsxindex 0d93190b307..508e4ad8ff1 100644--- a/frontend/src/metabase/embedding/settings/EmbeddingSecuritySettings/EmbeddingAppSameSiteCookieDescription.tsx+++ b/frontend/src/metabase/embedding/settings/EmbeddingSecuritySettings/EmbeddingAppSameSiteCookieDescription.tsx@@ -12,7 +12,7 @@ import S from "./EmbeddingAppSameSiteCookieDescription.module.css";export const EmbeddingAppSameSiteCookieDescription = () => {const docsUrl = useSelector((state) =>getDocsUrl(state, {- page: "embedding/interactive-embedding",+ page: "embedding/full-app-embedding",anchor: "embedding-metabase-in-a-different-domain",}),);diff --git a/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.tsx b/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.tsxindex b034253e7a7..8f7ca5daac8 100644--- a/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.tsx+++ b/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.tsx@@ -33,7 +33,7 @@ export function EnableEmbeddingPrompt({const usageConditionsLink = (<Anchorkey="usage-conditions"- href="https://metabase.com/license/embedding"+ href="https://www.metabase.com/license/embedding"target="_blank">{t`usage conditions`}diff --git a/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.unit.spec.tsx b/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.unit.spec.tsxindex f2f50f7b76f..6f0954b19c7 100644--- a/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.unit.spec.tsx+++ b/frontend/src/metabase/embedding/themes/components/ThemeEditor/EnableEmbeddingPrompt.unit.spec.tsx@@ -59,7 +59,7 @@ describe("EnableEmbeddingPrompt", () => {).toBeInTheDocument();expect(screen.getByRole("link", { name: "usage conditions" }),- ).toHaveAttribute("href", "https://metabase.com/license/embedding");+ ).toHaveAttribute("href", "https://www.metabase.com/license/embedding");await userEvent.click(screen.getByRole("button", { name: "Enable modular embedding" }),@@ -90,7 +90,7 @@ describe("EnableEmbeddingPrompt", () => {const link = screen.getByRole("link", { name: "usage conditions" });expect(link).toHaveAttribute("href",- "https://metabase.com/license/embedding",+ "https://www.metabase.com/license/embedding",);expect(link).toHaveAttribute("target", "_blank");diff --git a/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.stories.tsx b/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.stories.tsxindex 5a947e0f2c2..c96f39f926d 100644--- a/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.stories.tsx+++ b/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.stories.tsx@@ -33,9 +33,8 @@ export const Default: Story = {hasExampleDashboard: true,variant: "ee",hasEmbeddingFeature: false,- embeddingDocsUrl:- "https://www.metabase.com/docs/latest/embedding/start.html",+ embeddingDocsUrl: "https://www.metabase.com/docs/latest/embedding/start",analyticsDocsUrl:- "https://www.metabase.com/learn/customer-facing-analytics/",+ "https://www.metabase.com/docs/latest/embedding/introduction",},};diff --git a/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.tsx b/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.tsxindex ce0a5f17274..a9731607bba 100644--- a/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.tsx+++ b/frontend/src/metabase/home/components/EmbedHomepage/EmbedHomepage.tsx@@ -20,17 +20,17 @@ export const EmbedHomepage = () => {const learnMoreInteractiveEmbedding = useSelector((state) =>// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- this is only visible to admins- getDocsUrl(state, { page: "embedding/interactive-embedding" }),+ getDocsUrl(state, { page: "embedding/full-app-embedding" }),);const learnMoreStaticEmbedding = useSelector((state) =>// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- this is only visible to admins- getDocsUrl(state, { page: "embedding/static-embedding" }),+ getDocsUrl(state, { page: "embedding/guest-embedding" }),);const embedJsDocsUrl = useSelector((state) =>// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- this is only visible to admins- getDocsUrl(state, { page: "embedding/embedded-analytics-js" }),+ getDocsUrl(state, { page: "embedding/modular-embedding" }),);const plan = useSelector((state) =>@@ -55,7 +55,7 @@ export const EmbedHomepage = () => {embeddingDocsUrl={embeddingDocsUrl + utmTags}analyticsDocsUrl={// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- only visible to admins- "https://www.metabase.com/learn/customer-facing-analytics/" + utmTags+ "https://www.metabase.com/docs/latest/embedding/introduction" + utmTags}learnMoreInteractiveEmbedUrl={learnMoreInteractiveEmbedding + utmTags}learnMoreStaticEmbedUrl={learnMoreStaticEmbedding + utmTags}diff --git a/frontend/src/metabase/home/components/EmbedHomepage/tests/EmbedHomepage.unit.spec.tsx b/frontend/src/metabase/home/components/EmbedHomepage/tests/EmbedHomepage.unit.spec.tsxindex 1a8e236261c..cc6d1acae49 100644--- a/frontend/src/metabase/home/components/EmbedHomepage/tests/EmbedHomepage.unit.spec.tsx+++ b/frontend/src/metabase/home/components/EmbedHomepage/tests/EmbedHomepage.unit.spec.tsx@@ -12,7 +12,7 @@ describe("EmbedHomepage (OSS)", () => {screen.getAllByRole("link", { name: "Read the docs" })[0],).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/static-embedding.html?utm_source=product&source_plan=oss&utm_content=embedding-homepage",+ "https://www.metabase.com/docs/latest/embedding/guest-embedding.html?utm_source=product&source_plan=oss&utm_content=embedding-homepage",);});@@ -30,7 +30,7 @@ describe("EmbedHomepage (OSS)", () => {expect(readEmbedJsDocsLink).toHaveAttribute("href",- "https://www.metabase.com/docs/latest/embedding/embedded-analytics-js.html?utm_source=product&source_plan=oss&utm_content=embedding-homepage",+ "https://www.metabase.com/docs/latest/embedding/modular-embedding.html?utm_source=product&source_plan=oss&utm_content=embedding-homepage",);});diff --git a/frontend/src/metabase/nav/components/StoreLink/StoreLink.tsx b/frontend/src/metabase/nav/components/StoreLink/StoreLink.tsxindex 50152290deb..0cdf567431f 100644--- a/frontend/src/metabase/nav/components/StoreLink/StoreLink.tsx+++ b/frontend/src/metabase/nav/components/StoreLink/StoreLink.tsx@@ -9,7 +9,7 @@ const StoreLink = () => {return (<Tooltip label={t`Explore paid features`}><ExternalLink- href="https://metabase.com/upgrade"+ href="https://www.metabase.com/upgrade"data-testid="store-link"className={S.root}>diff --git a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParamParts/FilterWidgetTypeSelect.tsx b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParamParts/FilterWidgetTypeSelect.tsxindex c7652aa46d3..f1ab48448bd 100644--- a/frontend/src/metabase/parameters/components/TagEditor/TagEditorParamParts/FilterWidgetTypeSelect.tsx+++ b/frontend/src/metabase/parameters/components/TagEditor/TagEditorParamParts/FilterWidgetTypeSelect.tsx@@ -37,8 +37,8 @@ export function FilterWidgetTypeSelect({);const { url: docsUrl, showMetabaseLinks } = useDocsUrl(- "questions/native-editor/sql-parameters",- { anchor: "the-field-filter-variable-type" },+ "questions/native-editor/field-filters",+ { anchor: "field-filter-variables" },);return (diff --git a/frontend/src/metabase/public/hooks/use-embed-frame-options.ts b/frontend/src/metabase/public/hooks/use-embed-frame-options.tsindex c45d11a52cd..5acb960ea8b 100644--- a/frontend/src/metabase/public/hooks/use-embed-frame-options.ts+++ b/frontend/src/metabase/public/hooks/use-embed-frame-options.ts@@ -27,9 +27,9 @@ export const useEmbedFrameOptions = ({ location }: { location: Location }) => {// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- this is a console.error for a deprecated parameterconst { url: staticEmbedParametersDocsUrl } = useDocsUrl(- "embedding/static-embedding-parameters",+ "embedding/guest-embedding",{- anchor: "customizing-the-appearance-of-a-static-embed",+ anchor: "customizing-appearance-of-guest-embeds",},);diff --git a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/ImpossibleToCreateModelModal.tsx b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/ImpossibleToCreateModelModal.tsxindex 8e65d421205..abeb19817c7 100644--- a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/ImpossibleToCreateModelModal.tsx+++ b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/ImpossibleToCreateModelModal.tsx@@ -15,7 +15,7 @@ type Props = {function SQLSnippetsDocLink() {const href = useSelector((state) =>- getDocsUrl(state, { page: "questions/native-editor/sql-snippets" }),+ getDocsUrl(state, { page: "questions/native-editor/snippets" }),);return <ExternalLink href={href}>{t`SQL snippets`}</ExternalLink>;}diff --git a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/common.unit.spec.ts b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/common.unit.spec.tsindex 88e986d7a1d..f9ef1cdacdd 100644--- a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/common.unit.spec.ts+++ b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/common.unit.spec.ts@@ -10,7 +10,7 @@ describe("ImpossibleToCreateModelModal (OSS)", () => {expect(sqlSnippetLink).toBeInTheDocument();expect(sqlSnippetLink).toHaveProperty("href",- "https://www.metabase.com/docs/latest/questions/native-editor/sql-snippets.html",+ "https://www.metabase.com/docs/latest/questions/native-editor/snippets.html",);const referenceLink = screen.getByRole("link", {@@ -30,7 +30,7 @@ describe("ImpossibleToCreateModelModal (OSS)", () => {expect(sqlSnippetLink).toBeInTheDocument();expect(sqlSnippetLink).toHaveProperty("href",- "https://www.metabase.com/docs/latest/questions/native-editor/sql-snippets.html",+ "https://www.metabase.com/docs/latest/questions/native-editor/snippets.html",);const referenceLink = screen.getByRole("link", {diff --git a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/enterprise.unit.spec.ts b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/enterprise.unit.spec.tsindex 2f0100492e7..a1c3e13022e 100644--- a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/enterprise.unit.spec.ts+++ b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/enterprise.unit.spec.ts@@ -15,7 +15,7 @@ describe("ImpossibleToCreateModelModal (EE without token)", () => {expect(sqlSnippetLink).toBeInTheDocument();expect(sqlSnippetLink).toHaveProperty("href",- "https://www.metabase.com/docs/latest/questions/native-editor/sql-snippets.html",+ "https://www.metabase.com/docs/latest/questions/native-editor/snippets.html",);const referenceLink = screen.getByRole("link", {@@ -35,7 +35,7 @@ describe("ImpossibleToCreateModelModal (EE without token)", () => {expect(sqlSnippetLink).toBeInTheDocument();expect(sqlSnippetLink).toHaveProperty("href",- "https://www.metabase.com/docs/latest/questions/native-editor/sql-snippets.html",+ "https://www.metabase.com/docs/latest/questions/native-editor/snippets.html",);const referenceLink = screen.getByRole("link", {diff --git a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/premium.unit.spec.ts b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/premium.unit.spec.tsindex 10c201b783e..f9d42cae64c 100644--- a/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/premium.unit.spec.ts+++ b/frontend/src/metabase/query_builder/components/ImpossibleToCreateModelModal/tests/premium.unit.spec.ts@@ -19,7 +19,7 @@ describe("ImpossibleToCreateModelModal (EE with token)", () => {expect(sqlSnippetLink).toBeInTheDocument();expect(sqlSnippetLink).toHaveProperty("href",- "https://www.metabase.com/docs/latest/questions/native-editor/sql-snippets.html",+ "https://www.metabase.com/docs/latest/questions/native-editor/snippets.html",);const referenceLink = screen.getByRole("link", {diff --git a/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/MetricEditorSidebar.tsx b/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/MetricEditorSidebar.tsxindex fc1083e0091..56a6ccbd0f0 100644--- a/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/MetricEditorSidebar.tsx+++ b/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/MetricEditorSidebar.tsx@@ -10,8 +10,8 @@ export function MetricEditorSidebar() {const showMetabaseLinks = useSelector(getShowMetabaseLinks);const docsUrl = useSelector((state) =>getDocsUrl(state, {- page: "data-modeling/metrics",- anchor: "creating-a-metric",+ page: "data-modeling/semantic-layer/metrics",+ anchor: "create-a-metric",}),);diff --git a/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/tests/common.unit.spec.tsx b/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/tests/common.unit.spec.tsxindex e0ad3ebd254..7029d6b8a2d 100644--- a/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/tests/common.unit.spec.tsx+++ b/frontend/src/metabase/querying/metrics/components/MetricEditor/MetricEditorBody/MetricEditorSidebar/tests/common.unit.spec.tsx@@ -10,7 +10,7 @@ describe("MetricEditorSidebar (OSS)", () => {expect(link).toHaveAttribute("target", "_blank");expect(link).toHaveAttribute("href",- expect.stringContaining("data-modeling/metrics"),+ expect.stringContaining("data-modeling/semantic-layer/metrics"),);});});diff --git a/frontend/src/metabase/reference/segments/SegmentList/SegmentList.tsx b/frontend/src/metabase/reference/segments/SegmentList/SegmentList.tsxindex 939015b2c88..4a4b4e9d2ca 100644--- a/frontend/src/metabase/reference/segments/SegmentList/SegmentList.tsx+++ b/frontend/src/metabase/reference/segments/SegmentList/SegmentList.tsx@@ -45,8 +45,8 @@ export function SegmentList({ style }: SegmentListProps) {const { data: segments = [], isLoading, error } = useListSegmentsQuery();const adminLink = useSelector((state) =>getDocsUrl(state, {- page: "data-modeling/segments",- anchor: "creating-a-segment",+ page: "data-modeling/semantic-layer/segments",+ anchor: "create-segments",}),);const showMetabaseLinks = useSelector(getShowMetabaseLinks);diff --git a/frontend/src/metabase/selectors/settings.ts b/frontend/src/metabase/selectors/settings.tsindex b7ac8f87cc3..7d44f63008f 100644--- a/frontend/src/metabase/selectors/settings.ts+++ b/frontend/src/metabase/selectors/settings.ts@@ -39,7 +39,8 @@ export function getStoreUrl(state: State, path: StorePaths = "") {}export const migrateToCloudGuideUrl = () =>- "https://www.metabase.com/cloud/docs/migrate/guide";+ // eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- Only shown on Cloud during setup, before whitelabeling can be configured+ "https://www.metabase.com/docs/latest/cloud/migrate/guide";export const getLearnUrl = (path = "") => {// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- This is the implementation of getLearnUrl()diff --git a/lint-staged.config.cjs b/lint-staged.config.cjsindex a664e7f46e5..e2a417de777 100644--- a/lint-staged.config.cjs+++ b/lint-staged.config.cjs@@ -12,7 +12,7 @@ module.exports = {"+(frontend|enterprise/frontend)/**/*.{js,jsx,ts,tsx}": [`cross-env LINT_CSS_MODULES=true ${lintFix}`,"oxfmt --write",- "node ./bin/verify-doc-links",+ "bun bin/verify-doc-links/verify-doc-links.ts",],"e2e/**/!(cypress_sample_instance_data).{js,jsx,ts,tsx}": [lintFix,diff --git a/modules/drivers/clickhouse/README.md b/modules/drivers/clickhouse/README.mdindex 3a2b2a7a730..2e022250e99 100644--- a/modules/drivers/clickhouse/README.md+++ b/modules/drivers/clickhouse/README.md@@ -2,7 +2,7 @@### Attribution-The ClickHouse driver for Metabase was originally developed and maintained by ClickHouse at https://github.com/ClickHouse/metabase-clickhouse-driver, as part of Metabase's [partner driver program](https://www.metabase.com/docs/latest/developers-guide/partner-and-community-drivers). It has since been added to Metabase as an officially supported driver.+The ClickHouse driver for Metabase was originally developed and maintained by ClickHouse at https://github.com/ClickHouse/metabase-clickhouse-driver, as part of Metabase's [partner driver program](https://www.metabase.com/docs/latest/developers-guide/community-drivers). It has since been added to Metabase as an officially supported driver.**Contributors**- Felix Mueller (@enqueue)diff --git a/modules/drivers/oracle/resources/metabase/oracle/metabase-plugin.yaml b/modules/drivers/oracle/resources/metabase/oracle/metabase-plugin.yamlindex 7efade02bf3..8b96e7f84a4 100644--- a/modules/drivers/oracle/resources/metabase/oracle/metabase-plugin.yaml+++ b/modules/drivers/oracle/resources/metabase/oracle/metabase-plugin.yaml@@ -7,7 +7,7 @@ dependencies:message: >Metabase requires the Oracle JDBC driver in order to connect to Oracle databases, but we can't ship it as partof Metabase due to licensing restrictions. See- https://metabase.com/docs/latest/administration-guide/databases/oracle.html for more details.+ https://www.metabase.com/docs/latest/databases/connections/oracle for more details.driver:name: oracledisplay-name: Oraclediff --git a/modules/drivers/vertica/resources/metabase/vertica/metabase-plugin.yaml b/modules/drivers/vertica/resources/metabase/vertica/metabase-plugin.yamlindex abc99d2884b..7bc6de44b52 100644--- a/modules/drivers/vertica/resources/metabase/vertica/metabase-plugin.yaml+++ b/modules/drivers/vertica/resources/metabase/vertica/metabase-plugin.yaml@@ -7,7 +7,7 @@ dependencies:message: >Metabase requires the Vertica JDBC driver in order to connect to Vertica databases, but we can't ship it as partof Metabase due to licensing restrictions. See- https://metabase.com/docs/latest/administration-guide/databases/vertica.html for more details.+ https://www.metabase.com/docs/latest/databases/connections/vertica for more details.driver:name: verticadisplay-name: Verticadiff --git a/package.json b/package.jsonindex 311dc7df2cd..f55236970cc 100644--- a/package.json+++ b/package.json@@ -478,7 +478,7 @@"generate-openapi": "clojure -M:run:ee generate-openapi-spec","lint-openapi": "redocly lint resources/openapi/openapi.json --skip-rule security-defined --skip-rule operation-operationId --skip-rule no-unused-components --skip-rule info-license --skip-rule no-path-trailing-slash --skip-rule no-identical-paths --skip-rule no-ambiguous-paths --skip-rule path-parameters-defined --skip-rule spec-components-invalid-map-name","lint": "bun run lint-oxlint && bun run lint-format && bun run lint-docs-links && bun run lint-yaml",- "lint-docs-links": "bun install && ./bin/verify-doc-links",+ "lint-docs-links": "bun install && bun bin/verify-doc-links/verify-doc-links.ts","lint-css": "stylelint '{frontend,enterprise/frontend,e2e}/**/*.css'","lint-oxlint": "node frontend/lint/scripts/run-oxlint.mjs","test-oxlint": "node --test frontend/lint/tests/oxlint-*.test.mjs",diff --git a/resources/openapi/openapi.json b/resources/openapi/openapi.jsonindex 19d250b992c..1e42661908a 100644--- a/resources/openapi/openapi.json+++ b/resources/openapi/openapi.json@@ -37983,7 +37983,7 @@},"/api/notify/db/{id}" : {"post" : {- "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)",+ "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables#mb_api_key)","operationId" : "post-api-notify-db-id","parameters" : [ {"description" : "value must be an integer greater than zero.",diff --git a/resources/sample-content.edn b/resources/sample-content.ednindex 1dd9dffad52..5e0124f64bb 100644--- a/resources/sample-content.edn+++ b/resources/sample-content.edn@@ -692,7 +692,7 @@:card_id nil,:entity_id "OlrrrzZShIqvGE6RAjqbr",:visualization_settings- "{\"column_settings\":null,\"dashcard.background\":false,\"text\":\"Find more guides and tutorials on Metabase, analytics, data modeling, and more at [Metabase Learn](https://www.metabase.com/learn/)\\n\\n\",\"virtual_card\":{\"archived\":false,\"dataset_query\":{},\"display\":\"text\",\"name\":null,\"visualization_settings\":{}}}",+ "{\"column_settings\":null,\"dashcard.background\":false,\"text\":\"Find more guides and tutorials on Metabase, analytics, data modeling, and more at [Metabase Learn](https://www.metabase.com/learn)\\n\\n\",\"virtual_card\":{\"archived\":false,\"dataset_query\":{},\"display\":\"text\",\"name\":null,\"visualization_settings\":{}}}",:size_y 1,:dashboard_id 1,:created_at #t "2026-02-23T11:14:53.782096Z",diff --git a/src/metabase/app_db/env.clj b/src/metabase/app_db/env.cljindex 98be879a35f..8ff1734d118 100644--- a/src/metabase/app_db/env.clj+++ b/src/metabase/app_db/env.clj@@ -173,7 +173,7 @@["WARNING: Using Metabase with an H2 application database is not recommended for production deployments.""For production deployments, we highly recommend using Postgres, MySQL, or MariaDB instead.""If you decide to continue to use H2, please be sure to back up the database file regularly."- "For more information, see https://metabase.com/docs/latest/operations-guide/migrating-from-h2.html"]))))+ "For more information, see https://www.metabase.com/docs/latest/installation-and-operation/migrating-from-h2"]))))(defn db-file"Path to our H2 DB file from env var or app config."diff --git a/src/metabase/app_db/setup.clj b/src/metabase/app_db/setup.cljindex 927a16b2309..e04a76327f7 100644--- a/src/metabase/app_db/setup.clj+++ b/src/metabase/app_db/setup.clj@@ -235,7 +235,7 @@"\n\n"(trs "Once your database has been downgraded, try running the application again.")"\n\n"- (trs "See: https://www.metabase.com/docs/latest/installation-and-operation/upgrading-metabase#rolling-back-an-upgrade"))+ (trs "See: https://www.metabase.com/docs/latest/installation-and-operation/upgrading-metabase#rolling-back-an-upgrade-or-to-an-older-version")){})))))))(mu/defn- run-schema-migrations!diff --git a/src/metabase/appearance/settings.clj b/src/metabase/appearance/settings.cljindex 995396c96f9..cc8a13bd463 100644--- a/src/metabase/appearance/settings.clj+++ b/src/metabase/appearance/settings.clj@@ -394,7 +394,7 @@ See [fonts](../configuring-metabase/fonts.md)."):visibility :authenticated:type :string:audit :getter- :default "https://www.metabase.com/help/premium"+ :default "https://www.metabase.com/help-premium":feature :whitelabel:setter (fn [new-value](let [new-value-string (str new-value)]diff --git a/src/metabase/channel/email/messages.clj b/src/metabase/channel/email/messages.cljindex dc5c29ab12e..a4e6e746618 100644--- a/src/metabase/channel/email/messages.clj+++ b/src/metabase/channel/email/messages.clj@@ -309,7 +309,7 @@:logoHeader true:heading (trs "We hope you''ve been enjoying Metabase."):callToAction (trs "Would you mind taking a quick 5 minute survey to tell us how it’s going?")- :link "https://metabase.com/feedback/active"})+ :link "https://www.metabase.com/feedback/active"})email-msg {:subject (trs "[{0}] Tell us how things are going." (app-name-trs)):recipients [email]:message-type :html@@ -330,7 +330,7 @@{:emailType "notification":logoHeader true:first-name first_name- :link (cond-> "https://metabase.com/feedback/creator"+ :link (cond-> "https://www.metabase.com/feedback/creator"encoded-info (str "?context=" encoded-info))}(when-not (premium-features/is-hosted?){:self-hosted (system/site-url)}))diff --git a/src/metabase/channel/email/persisted-model-error.hbs b/src/metabase/channel/email/persisted-model-error.hbsindex 4aa08bb66ca..248d6ae9df6 100644--- a/src/metabase/channel/email/persisted-model-error.hbs+++ b/src/metabase/channel/email/persisted-model-error.hbs@@ -104,7 +104,7 @@style="font-size: 0.875em; font-weight: 600; line-height: 1.375em; color: #A4ADCA; margin-top: 1em;">If you run into any issues, check out our- <a href="https://www.metabase.com/docs/latest/troubleshooting-guide/datawarehouse.html" style="color: #A4ADCA;">troubleshooting</a> guides.+ <a href="https://www.metabase.com/docs/latest/troubleshooting-guide/db-connection" style="color: #A4ADCA;">troubleshooting</a> guides.</p></div>{{> _footer }}diff --git a/src/metabase/channel/email/warn_deprecate_pulse.hbs b/src/metabase/channel/email/warn_deprecate_pulse.hbsindex 8acde6c08e0..fb10d1c4e73 100644--- a/src/metabase/channel/email/warn_deprecate_pulse.hbs+++ b/src/metabase/channel/email/warn_deprecate_pulse.hbs@@ -9,7 +9,7 @@<li><a href="{{{this.url}}}">{{this.name}}</a></li>{{/each}}</ul>-<p>You can replace legacy Pulses with <a href="https://www.metabase.com/docs/latest/questions/sharing/pulses">dashboards subscriptions and alerts</a>.</p>+<p>You can replace legacy Pulses with <a href="https://www.metabase.com/docs/latest/dashboards/subscriptions">dashboards subscriptions and alerts</a>.</p><p>This message was sent to all Admins of <a href="{{instanceURL}}">{{instanceURL}}</a>.</p><p>Onward!</p><p>- The Metabase Team</p>diff --git a/src/metabase/core/core.clj b/src/metabase/core/core.cljindex 885c0caa832..4ae91449cbc 100644--- a/src/metabase/core/core.clj+++ b/src/metabase/core/core.clj@@ -65,7 +65,7 @@(str "Metabase Enterprise Edition extensions are PRESENT.""\n\n""Usage of Metabase Enterprise Edition features are subject to the Metabase Commercial License."- "See https://www.metabase.com/license/commercial/ for details.")+ "See https://www.metabase.com/license/commercial for details.")"Metabase Enterprise Edition extensions are NOT PRESENT.")));;; --------------------------------------------------- Info Metric---------------------------------------------------diff --git a/src/metabase/driver/common.clj b/src/metabase/driver/common.cljindex 38dbc28dd05..44fef6eaa2a 100644--- a/src/metabase/driver/common.clj+++ b/src/metabase/driver/common.clj@@ -335,7 +335,7 @@(when-let [ips (warehouses/cloud-gateway-ips)](str (deferred-tru(str "If your database is behind a firewall, you may need to allow connections from our Metabase "- "[Cloud IP addresses](https://www.metabase.com/cloud/docs/ip-addresses-to-whitelist.html):"))+ "[Cloud IP addresses](https://www.metabase.com/docs/latest/cloud/ip-addresses-to-whitelist):"))"\n"(str/join " - " ips))))})diff --git a/src/metabase/sync/api/notify.clj b/src/metabase/sync/api/notify.cljindex fe1bd257fb8..828de8252d7 100644--- a/src/metabase/sync/api/notify.clj+++ b/src/metabase/sync/api/notify.clj@@ -26,7 +26,7 @@`Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, availableregardless if a `:table_id` or `:table_name` is passed.This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in- the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)"+ the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables#mb_api_key)"[{:keys [id]} :- [:map {:closed true}[:id ms/PositiveInt]]_query-paramsdiff --git a/src/metabase/util/encryption.clj b/src/metabase/util/encryption.cljindex 27979295c30..35011f77190 100644--- a/src/metabase/util/encryption.clj+++ b/src/metabase/util/encryption.clj@@ -72,7 +72,7 @@"Saved credentials encryption is DISABLED for this Metabase instance.")(u/emoji (if default-secret-key "🔐" "🔓"))"\n"- "For more information, see https://metabase.com/docs/latest/operations-guide/encrypting-database-details-at-rest.html"))+ "For more information, see https://www.metabase.com/docs/latest/databases/encrypting-details-at-rest"))(defn- opts->secret-key"The 64-byte key `opts` name, or the hashed MB_ENCRYPTION_SECRET_KEY when they name none."diff --git a/test/metabase/appearance/settings_test.clj b/test/metabase/appearance/settings_test.cljindex 4e69b25d818..d4151b0d1f5 100644--- a/test/metabase/appearance/settings_test.clj+++ b/test/metabase/appearance/settings_test.clj@@ -205,7 +205,7 @@clojure.lang.ExceptionInfo#"Setting help-link-custom-destination is not enabled because feature :whitelabel is not available"(appearance.settings/help-link-custom-destination! "http://www.metabase.com")))- (is (= "https://www.metabase.com/help/premium" (appearance.settings/help-link-custom-destination))))))+ (is (= "https://www.metabase.com/help-premium" (appearance.settings/help-link-custom-destination))))))(deftest landing-page-setting-test(mt/with-temporary-setting-values [site-url "http://localhost:3000"]diff --git a/tsconfig.json b/tsconfig.jsonindex ae6e6b26c5e..9545d5a362d 100644--- a/tsconfig.json+++ b/tsconfig.json@@ -52,7 +52,8 @@"enterprise/frontend/src/**/*","frontend/test/**/*","enterprise/frontend/test/**/*",- ".github/scripts/**/*"+ ".github/scripts/**/*",+ "bin/verify-doc-links/**/*"],"exclude": ["node_modules",