Skip to content

Commit 9fe50dd

Browse files
github-automation-metabaseMetabase Docs botescherize
authored
[auto] adding content to endpoint-dox-response-schemas->master (#332)
Co-authored-by: Metabase Docs bot <[email protected]> Co-authored-by: Bryan Maass <[email protected]>
1 parent d856847 commit 9fe50dd

File tree

6 files changed

+40
-5314
lines changed

6 files changed

+40
-5314
lines changed

_docs/master/embedding/sdk/upgrade.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

_docs/master/embedding/sdk/version.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,35 @@ layout: new-docs
1515

1616
The SDK stable version tracks with the Metabase version.
1717

18-
So, for example, if you're on Metabase 55 (`0.55.x`, `1.55.x`), _any_ version 0.55.x of the @metabase/embedding-sdk-react npm package will be compatible.
18+
So, for example, if you're on Metabase 53 (`0.53.x`, `1.53.x`), _any_ version 0.53.x of the @metabase/embedding-sdk-react npm package will be compatible.
1919

20-
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 55, run:
20+
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 53, run:
2121

2222
```sh
23-
npm install @metabase/embedding-sdk-react@55-stable
23+
npm install @metabase/embedding-sdk-react@53-stable
2424
```
2525

2626
To grab the latest version of the SDK that works with Metabase nightly builds, use the `canary` dist-tag.
2727

2828
## Minimum SDK version
2929

30-
Version 52 is the minimum version supported for the Embedded analytics SDK.
30+
52 is the minimum version supported for the Embedded analytics SDK.
3131

32-
## Instances on Metabase Cloud will be pinned to a specific version
32+
## Version pinning when using the SDK with Metabase Cloud
3333

34-
By default, if you're running on Metabase Cloud and using the Embedded analytics SDK, we'll pin your version to avoid breaking changes.
34+
To pin your version of Metabase, go to **Admin settings > Settings > Embedding**. Go to the Embedded analytics SDK card and scroll to **Version pinning** and click **Request version pinning**.
3535

36-
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so you don't have to deal with upgrades. But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
36+
## Version pinning requirements
3737

38-
### Manually pinning your instance version on Metabase Cloud
38+
To pin a version of Metabase, you must:
3939

40-
To manually pin your version of Metabase:
40+
- Be on Metabase Cloud (obviously)
41+
- Be on the Pro or Enterprise plans
4142

42-
1. Go to **Admin settings > Settings > Embedding**.
43-
2. Go to the Embedded analytics SDK card.
44-
3. Scroll to **Version pinning** and click **Request version pinning**.
43+
## Why you'd want to pin your Metabase Cloud version
4544

46-
This will open a mailto link to our support team.
45+
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that you don't have to deal with upgrades.
46+
47+
But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
48+
49+
To upgrade manually, you can pin your Metabase version so that it stays in sync with the SDK version you're using. That way you can choose when to upgrade your Metabase.

_docs/master/installation-and-operation/upgrading-metabase.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,11 @@ redirect_from:
1313

1414
# Upgrading Metabase
1515

16-
This page covers how to upgrade to a new Metabase release.
17-
18-
- [Announcement posts for major releases](https://www.)
19-
- [Changelogs](/changelog).
20-
- [Release notes on GitHub](https://github.com/metabase/metabase/releases).
16+
This page covers how to upgrade to a new [Metabase release](https://github.com/metabase/metabase/releases).
2117

2218
## Upgrading Metabase Cloud
2319

24-
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end ([unless you're using the Embedded analytics SDK](#instances-using-the-embedded-analtyics-sdk-on-metabase-cloud-must-request-an-upgrade)).
20+
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end.
2521

2622
How soon we upgrade you depends on the type of release:
2723

@@ -30,14 +26,6 @@ How soon we upgrade you depends on the type of release:
3026

3127
Cloud customers can request an early upgrade by emailing support at [email protected]. Include the URL of the Metabase you want us to upgrade.
3228

33-
### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade
34-
35-
If you're using the [Embedded analytics SDK](../embedding/sdk/introduction) on Metabase Cloud, we pin your version so that it doesn't upgrade automatically, as you should test the changes before upgrading.
36-
37-
To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).
38-
39-
See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).
40-
4129
## Upgrading a self-hosted Metabase
4230

4331
Here are the steps for upgrading to a new Metabase version (major or minor):

0 commit comments

Comments
 (0)