Snippets Groups Projects

Add Embedding SDK readme (#41776)

Mahatthana (Kelvin) Nomsawadi authored 10 months ago

* Add Embedding SDK readme

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Nicolò Pretto <info@npretto.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Phoomparin Mano <poom@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Phoomparin Mano <poom@metabase.com>

* Clarify the result from `useQuestionSearch`

* Remove the mentioning of API key

Since we want to drop API key support for embedding SDK

* Add more detail

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Oisin Coveney <oisin@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Phoomparin Mano <poom@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Oisin Coveney <oisin@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Oisin Coveney <oisin@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Phoomparin Mano <poom@metabase.com>

* Update enterprise/frontend/src/embedding-sdk/docs/README.md

Co-authored-by: Oisin Coveney <oisin@metabase.com>

* Remove private GH repo

* Remove the compatibility table until we've made the first release

* Fix typo

* Add details how to run with locally built SDK

* Correct Metabase Embedding SDK case

* Make the instruction more concise

* Add a disclaimer

* Update config removing deleted property

* Add Oisin suggestion that was missed from rebasing

* Clarify plugin section

* Tweak SDK Readme

* Polish the limitation section

* Update the code sample into 4 sections making it easier to read

* Tweak overview and features section of README

* Add metabase configuration section

* Clean up section

* Replace the doc in the root embedding SDK directory

* Some tweaks and improvements to SDK README

* Tweaks to SDK README: wording, change flow, add section on running MB from master

* Update enterprise/frontend/src/embedding-sdk/README.md

Co-authored-by: Oisin Coveney <oisin@metabase.com>

* Feedback section

* Add simple InteractiveQuestion example

* SDK README: Tweak Slack wording

* Standardize fullstops + fix typo

* Clean up formatting

---------

Co-authored-by: Nicolò Pretto <info@npretto.com>
Co-authored-by: Phoomparin Mano <poom@metabase.com>
Co-authored-by: Oisin Coveney <oisin@metabase.com>
Co-authored-by: Alberto Perdomo <alberto.perdomo@gmail.com>

48e48889

48e48889 10 months ago

Code owners

Assign users and groups as approvers for specific file changes. Learn more.

Name	Last commit	Last update
..
backend
frontend
LICENSE.txt
README.md

Metabase Enterprise Edition

License

Usage of files in this directory and its subdirectories, and of Metabase Enterprise Edition features, is subject to the Metabase Commercial License, and conditional on having a fully-paid-up license from Metabase. Access to files in this directory and its subdirectories does not constitute permission to use this code or Metabase Enterprise Edition features.

Unless otherwise noted, all files Copyright © 2024 Metabase, Inc.

Running it

Front-end

MB_EDITION=ee yarn build-hot

Clear the Webpack cache using yarn remove-webpack-cache if you previously ran OSS edition in dev mode to avoid unexpected application behavior.

Back-end

You need to add the :ee alias to the Clojure CLI command to run Metabase Enterprise Edition.

# Start a local Metabase server that includes EE sources
clojure -M:ee:run

# start a REPL that includes EE sources.
clojure -A:ee

# start a REPL that includes EE sources & test namespaces.
clojure -A:dev:ee:ee-dev