From a20c1ff53a764383722017e03901dc442441a75e Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:53:13 -0500 Subject: [PATCH 01/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 7ed40c503..e89a46d9a 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -1,5 +1,9 @@ # Apache Superset +## Table of contents +### [Prerequisites](#prerequisites-1) +### [Introduction](#introduction-1) + ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. * [Node.js](https://nodejs.org/en/about) for Backend-related knowledge. From f6f3c3626c0aad4b8e6cc2a3e3e35d72bd2f2d71 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:54:50 -0500 Subject: [PATCH 02/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index e89a46d9a..968260a3b 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -3,6 +3,10 @@ ## Table of contents ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) +### [Set-up](#set-up-1) +### [Potential Issues with Docker Desktop](#potentialissue-1) +### [Potential Issues with Installing from Scratch](#potentialissue-2) +### [Extra Resources](#extra-resource-1) ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. From 9fecbfd1e71492a56cc4e2e1202aa6248b7198b3 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:55:29 -0500 Subject: [PATCH 03/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 968260a3b..ca807d15c 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -4,8 +4,6 @@ ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) ### [Set-up](#set-up-1) -### [Potential Issues with Docker Desktop](#potentialissue-1) -### [Potential Issues with Installing from Scratch](#potentialissue-2) ### [Extra Resources](#extra-resource-1) ## Prerequisites: From 59a8597958b8012fef85c1999620c57171b0a17b Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:56:11 -0500 Subject: [PATCH 04/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index ca807d15c..73ab5e16e 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -4,7 +4,7 @@ ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) ### [Set-up](#set-up-1) -### [Extra Resources](#extra-resource-1) +### [Extra Resources](#extra resources-1) ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. From ad1c8cfc3308478e57341303220952d857510c8b Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:56:21 -0500 Subject: [PATCH 05/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 73ab5e16e..4719cda01 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -4,7 +4,7 @@ ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) ### [Set-up](#set-up-1) -### [Extra Resources](#extra resources-1) +### [Extra Resources](#extraresources-1) ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. From 9e4b6891a809432598ab55c0fc65f82f4775bedb Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:57:58 -0500 Subject: [PATCH 06/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 4719cda01..d6bbf35a5 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -4,7 +4,7 @@ ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) ### [Set-up](#set-up-1) -### [Extra Resources](#extraresources-1) +### [Creating a custom plugin](#plugin-1) ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. @@ -43,6 +43,9 @@ This message shows up due to an update in version 2.1.0 to force secure configur 1. The command `pip install apache-superset` doesn't work. This is because Apache Superset currently supports python version 3.8 and 3.9. Any python versions that's lower or higher will result in a failure. +## Creating a custom plugin: +test + ## Extra Resources: From 958f1ff930c5d88e016c6d222e4a6b2c3693c505 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 17:59:53 -0500 Subject: [PATCH 07/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index d6bbf35a5..2f31db215 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -1,10 +1,16 @@ -# Apache Superset - -## Table of contents -### [Prerequisites](#prerequisites-1) -### [Introduction](#introduction-1) -### [Set-up](#set-up-1) -### [Creating a custom plugin](#plugin-1) +- [Apache Superset](#apache-superset) + * [Table of contents](#table-of-contents) + + [[Prerequisites](#prerequisites-1)](#-prerequisites---prerequisites-1-) + + [[Introduction](#introduction-1)](#-introduction---introduction-1-) + + [[Set-up](#set-up-1)](#-set-up---set-up-1-) + + [[Creating a custom plugin](#plugin-1)](#-creating-a-custom-plugin---plugin-1-) + * [Prerequisites:](#prerequisites-) + * [Introduction:](#introduction-) + * [Set-up:](#set-up-) + + [Potential Issues with Docker Desktop:](#potential-issues-with-docker-desktop-) + + [Potential Issues with Installing from Scratch:](#potential-issues-with-installing-from-scratch-) + * [Creating a custom plugin:](#creating-a-custom-plugin-) + * [Extra Resources:](#extra-resources-) ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. From 4c3dc85267d25bff07cf7dbadf2e3131d8fd07bd Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:00:32 -0500 Subject: [PATCH 08/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 2f31db215..223f44c13 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -12,6 +12,8 @@ * [Creating a custom plugin:](#creating-a-custom-plugin-) * [Extra Resources:](#extra-resources-) +Table of contents generated with markdown-toc + ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. * [Node.js](https://nodejs.org/en/about) for Backend-related knowledge. From 92eb2eeeeb02414fe367b60f1b7361ff7b615051 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:01:00 -0500 Subject: [PATCH 09/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 223f44c13..47b33178e 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -1,16 +1,9 @@ -- [Apache Superset](#apache-superset) - * [Table of contents](#table-of-contents) - + [[Prerequisites](#prerequisites-1)](#-prerequisites---prerequisites-1-) - + [[Introduction](#introduction-1)](#-introduction---introduction-1-) - + [[Set-up](#set-up-1)](#-set-up---set-up-1-) - + [[Creating a custom plugin](#plugin-1)](#-creating-a-custom-plugin---plugin-1-) - * [Prerequisites:](#prerequisites-) - * [Introduction:](#introduction-) - * [Set-up:](#set-up-) - + [Potential Issues with Docker Desktop:](#potential-issues-with-docker-desktop-) - + [Potential Issues with Installing from Scratch:](#potential-issues-with-installing-from-scratch-) - * [Creating a custom plugin:](#creating-a-custom-plugin-) - * [Extra Resources:](#extra-resources-) +# Apache Superset + +## Table of contents +### [Prerequisites](#prerequisites-1) +### [Introduction](#introduction-1) +### [Creating a custom plugin](#plugin-1) Table of contents generated with markdown-toc From 00dd19971bb02992a5929a3dd01f2d3cf49794e9 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:01:44 -0500 Subject: [PATCH 10/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 47b33178e..c31d140b9 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -3,9 +3,9 @@ ## Table of contents ### [Prerequisites](#prerequisites-1) ### [Introduction](#introduction-1) +### [Set-up](#setup-1) ### [Creating a custom plugin](#plugin-1) -Table of contents generated with markdown-toc ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. @@ -46,6 +46,7 @@ This message shows up due to an update in version 2.1.0 to force secure configur ## Creating a custom plugin: test +** hi ** ## Extra Resources: From 84bc0cd26790c83ee384ce620f7e5bf44ba1b25a Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:04:07 -0500 Subject: [PATCH 11/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index c31d140b9..fdafc396e 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -1,12 +1,5 @@ # Apache Superset -## Table of contents -### [Prerequisites](#prerequisites-1) -### [Introduction](#introduction-1) -### [Set-up](#setup-1) -### [Creating a custom plugin](#plugin-1) - - ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. * [Node.js](https://nodejs.org/en/about) for Backend-related knowledge. @@ -45,8 +38,11 @@ This message shows up due to an update in version 2.1.0 to force secure configur 1. The command `pip install apache-superset` doesn't work. This is because Apache Superset currently supports python version 3.8 and 3.9. Any python versions that's lower or higher will result in a failure. ## Creating a custom plugin: -test -** hi ** + +** To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** + + + ## Extra Resources: From d6e90a58af16ee553a95990d194769322d0bd0aa Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:09:54 -0500 Subject: [PATCH 12/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 36 +++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index fdafc396e..a718cf569 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -37,13 +37,45 @@ This message shows up due to an update in version 2.1.0 to force secure configur 1. The command `pip install apache-superset` doesn't work. This is because Apache Superset currently supports python version 3.8 and 3.9. Any python versions that's lower or higher will result in a failure. -## Creating a custom plugin: +## Creating a Custom Plugin: -** To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** +**To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** +There are example plugins [example](https://github.com/preset-io/superset-plugin-chart-liquid) which you can reference. Furthermore, this [youtube tutorial](https://www.youtube.com/watch?v=LDHFY9xTzls) can help you as well. +### Potential Issues Creating a Custom Plugin: +Note that one may get errors from `npm run build`, but those errors do not affect the actual building of the plugin. `npm` is a large package manager, and thus it yields irrelevant errors when trying to build the plugin. In case of version conflict errors with other tools under `npm`, it is recommended to use the `--force` flag, again due to the nature of `npm`. +To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `mapbox-plugin` plugin and `superset` repos are in the same root directory) and run +``` +npm i -S ../../mapbox-plugin +``` + +If your Superset plugin exists in the `superset-frontend` directory and you wish to resolve TypeScript errors about `@superset-ui/core` not being resolved correctly, add the following to your `tsconfig.json` file: + +``` +"references": [ + { + "path": "../../packages/superset-ui-chart-controls" + }, + { + "path": "../../packages/superset-ui-core" + } +] +``` + +You may also wish to add the following to the `include` array in `tsconfig.json` to make Superset types available to your plugin: + +``` +"../../types/**/*" +``` + +Finally, if you wish to ensure your plugin `tsconfig.json` is aligned with the root Superset project, you may add the following to your `tsconfig.json` file: + +``` +"extends": "../../tsconfig.json", +``` ## Extra Resources: From 54a1f422b7186ec258370b77b104872492eef7cf Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:10:34 -0500 Subject: [PATCH 13/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index a718cf569..22daec219 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -1,19 +1,23 @@ # Apache Superset + ## Prerequisites: * [React](https://react.dev/) for Frontend-related knowledge. * [Node.js](https://nodejs.org/en/about) for Backend-related knowledge. * [PostgreSQL](https://www.postgresql.org/) for SQL and Databases knowledge as well as writing queries. * [Python](https://www.python.org/) for writing scripts as well as changing parts of the configuration files. + ## Introduction: Apache Superset is a modern, enterprise-ready business intelligence web application. It is fast, lightweight, intuitive, and loaded with options that make it easy for users of all skill sets to explore and visualize their data, from simple pie charts to highly detailed deck.gl geospatial charts. + ## Set-up: **The easiest way to set up Apache Superset is by using Docker Desktop. To install Docker Desktop, follow the instruction [HERE](https://www.docker.com/products/docker-desktop/). You can find more details about installing Superset by Docker Desktop [HERE](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose).** + ### Potential Issues with Docker Desktop: 1. The container named `superset_init` may exit with a code one due to a thread deadlock. To fix this issue, simply kill the process using `CTRL + C`, and re-compose it again. @@ -37,6 +41,7 @@ This message shows up due to an update in version 2.1.0 to force secure configur 1. The command `pip install apache-superset` doesn't work. This is because Apache Superset currently supports python version 3.8 and 3.9. Any python versions that's lower or higher will result in a failure. + ## Creating a Custom Plugin: **To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** From 3d8ee6de73b1cbb85bd83eb866a953c5efb36387 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:11:10 -0500 Subject: [PATCH 14/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 22daec219..bcc283ef5 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -52,9 +52,9 @@ There are example plugins [example](https://github.com/preset-io/superset-plugin Note that one may get errors from `npm run build`, but those errors do not affect the actual building of the plugin. `npm` is a large package manager, and thus it yields irrelevant errors when trying to build the plugin. In case of version conflict errors with other tools under `npm`, it is recommended to use the `--force` flag, again due to the nature of `npm`. -To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `mapbox-plugin` plugin and `superset` repos are in the same root directory) and run +To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `your-plugin` plugin and `superset` repos are in the same root directory) and run ``` -npm i -S ../../mapbox-plugin +npm i -S ../../your-plugin ``` If your Superset plugin exists in the `superset-frontend` directory and you wish to resolve TypeScript errors about `@superset-ui/core` not being resolved correctly, add the following to your `tsconfig.json` file: From 0b743c51b271a33f99b189dbe927b80193affb09 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:47:17 -0500 Subject: [PATCH 15/17] Update Apache_Superset.md Added additional clarifications on creating a plugin --- Topics/Tech_Stacks/Apache_Superset.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index bcc283ef5..9187d0a07 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -48,10 +48,18 @@ This message shows up due to an update in version 2.1.0 to force secure configur There are example plugins [example](https://github.com/preset-io/superset-plugin-chart-liquid) which you can reference. Furthermore, this [youtube tutorial](https://www.youtube.com/watch?v=LDHFY9xTzls) can help you as well. +**To set up for the plug-in, you would need to have the following in your system:** +1) apache-superset 3.0.0 +2) python 3.9.7 or above +3) node version 16 +4) npm version 7 or 8 + ### Potential Issues Creating a Custom Plugin: Note that one may get errors from `npm run build`, but those errors do not affect the actual building of the plugin. `npm` is a large package manager, and thus it yields irrelevant errors when trying to build the plugin. In case of version conflict errors with other tools under `npm`, it is recommended to use the `--force` flag, again due to the nature of `npm`. +**IMPORTANT** : You can put the mapbox-plugin folder anywhere in your machine EXCEPT in the superset/superset-frontend/plugins folder. The custom plugin will fail to run and cause errors if it is in that folder. This is because those are default plugins by Apache Superset and Apache Superset runs some processes on all folders in the plugin folder, which may cause errors for your plugin as your custom plugin does not have the same configurations as the default plugins provided. + To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `your-plugin` plugin and `superset` repos are in the same root directory) and run ``` npm i -S ../../your-plugin From e30ff310c08ff36acb76abf51ae3a0127e9fbe47 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:53:19 -0500 Subject: [PATCH 16/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 9187d0a07..781ac8f7a 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -58,7 +58,7 @@ There are example plugins [example](https://github.com/preset-io/superset-plugin Note that one may get errors from `npm run build`, but those errors do not affect the actual building of the plugin. `npm` is a large package manager, and thus it yields irrelevant errors when trying to build the plugin. In case of version conflict errors with other tools under `npm`, it is recommended to use the `--force` flag, again due to the nature of `npm`. -**IMPORTANT** : You can put the mapbox-plugin folder anywhere in your machine EXCEPT in the superset/superset-frontend/plugins folder. The custom plugin will fail to run and cause errors if it is in that folder. This is because those are default plugins by Apache Superset and Apache Superset runs some processes on all folders in the plugin folder, which may cause errors for your plugin as your custom plugin does not have the same configurations as the default plugins provided. +**IMPORTANT** : You can put the your-plugin folder anywhere in your machine EXCEPT in the superset/superset-frontend/plugins folder. The custom plugin will fail to run and cause errors if it is in that folder. This is because those are default plugins by Apache Superset and Apache Superset runs some processes on all folders in the plugin folder, which may cause errors for your plugin as your custom plugin does not have the same configurations as the default plugins provided. To add the package to Superset, go to the `superset-frontend` subdirectory in your Superset source folder (assuming both the `your-plugin` plugin and `superset` repos are in the same root directory) and run ``` From 25178976a8f6f743c448ac7cb05bcf7059e75ca6 Mon Sep 17 00:00:00 2001 From: Justin Zheng <83163126+justinzzy-code@users.noreply.github.com> Date: Fri, 24 Nov 2023 22:25:46 -0500 Subject: [PATCH 17/17] Update Apache_Superset.md --- Topics/Tech_Stacks/Apache_Superset.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Topics/Tech_Stacks/Apache_Superset.md b/Topics/Tech_Stacks/Apache_Superset.md index 781ac8f7a..e495065ac 100644 --- a/Topics/Tech_Stacks/Apache_Superset.md +++ b/Topics/Tech_Stacks/Apache_Superset.md @@ -44,7 +44,9 @@ This message shows up due to an update in version 2.1.0 to force secure configur ## Creating a Custom Plugin: -**To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** +**To get started on creating a custom plugin, you can follow the instruction [HERE](https://superset.apache.org/docs/contributing/creating-viz-plugins/)** + +Note that while MacOS or Linux systems are more suitable, Windows is also a viable option if you have docker installed. There are example plugins [example](https://github.com/preset-io/superset-plugin-chart-liquid) which you can reference. Furthermore, this [youtube tutorial](https://www.youtube.com/watch?v=LDHFY9xTzls) can help you as well.