korbit-ai[bot] commented on code in PR #36028: URL: https://github.com/apache/superset/pull/36028#discussion_r2499888320
########## docs/docs/contributing/howtos.mdx: ########## @@ -166,6 +166,56 @@ server: npm run dev-server ``` +#### Deploying your visualization plugin + +Once your plugin is complete, you will need to deploy it to your superset instance. + +This step assumes your are running your own docker image as described [here](https://superset.apache.org/docs/installation/docker-builds/#building-your-own-production-docker-image). Review Comment: ### Grammar error in assumption statement <sub></sub> <details> <summary>Tell me more</summary> ###### What is the issue? Grammatical error - 'your' should be 'you' in this sentence. ###### Why this matters This grammatical error reduces the professional quality of the documentation and could distract readers from the technical content. ###### Suggested change ∙ *Feature Preview* Change 'your are' to 'you are': ``` This step assumes you are running your own docker image ``` ###### Provide feedback to improve future suggestions [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/67eb83bf-68e2-41b2-b74c-2cb583e86a76/upvote) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/67eb83bf-68e2-41b2-b74c-2cb583e86a76?what_not_true=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/67eb83bf-68e2-41b2-b74c-2cb583e86a76?what_out_of_scope=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/67eb83bf-68e2-41b2-b74c-2cb583e86a76?what_not_in_standard=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/67eb83bf-68e2-41b2-b74c-2cb583e86a76) </details> <sub> 💬 Looking for more details? Reply to this comment to chat with Korbit. </sub> <!--- korbi internal id:d7ef36dd-09ef-4331-972f-b638fcedffd4 --> [](d7ef36dd-09ef-4331-972f-b638fcedffd4) ########## docs/docs/contributing/howtos.mdx: ########## @@ -166,6 +166,56 @@ server: npm run dev-server ``` +#### Deploying your visualization plugin + +Once your plugin is complete, you will need to deploy it to your superset instance. + +This step assumes your are running your own docker image as described [here](https://superset.apache.org/docs/installation/docker-builds/#building-your-own-production-docker-image). +Instructions may vary for other kinds of deployments. + +If you have your own superset docker image, your first line is most likely: +`FROM apache/superset:latest` or something similar. You will need to compile +your own `lean` image and replace this FROM line with your own image. + +1. publish your chart plugin to npm - it makes the build process simpler + +Note: if your chart is not published to npm, then in the docker build below, you will need +to edit the default Dockerfile to copy your plugin source code to the appropriate +location in the container build environment. + +2. Install your chart in the frontend with `npm i <your_chart_package>` +3. Start with a base superset release + +```bash +git checkout tags/X.0.0 +``` + +4. Install your chart with the instructions you followed during development. +5. navigate to the root of your superset directory. +6. Run `docker build -t apache/superset:mychart --target lean .` +7. Rebuild your projection container using `FROM apache/superset:mychart` Review Comment: ### Typo in deployment instruction <sub></sub> <details> <summary>Tell me more</summary> ###### What is the issue? The word 'projection' appears to be a typo and should be 'production' in the context of rebuilding a production container. ###### Why this matters This typo could confuse developers following the deployment instructions, potentially leading them to misunderstand the purpose of this step in the deployment process. ###### Suggested change ∙ *Feature Preview* Change 'projection' to 'production': ``` 7. Rebuild your production container using `FROM apache/superset:mychart` ``` ###### Provide feedback to improve future suggestions [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/f0f4dd5c-4808-445a-9930-f9a01d419dd8/upvote) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/f0f4dd5c-4808-445a-9930-f9a01d419dd8?what_not_true=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/f0f4dd5c-4808-445a-9930-f9a01d419dd8?what_out_of_scope=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/f0f4dd5c-4808-445a-9930-f9a01d419dd8?what_not_in_standard=true) [](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/f0f4dd5c-4808-445a-9930-f9a01d419dd8) </details> <sub> 💬 Looking for more details? Reply to this comment to chat with Korbit. </sub> <!--- korbi internal id:288abe66-c398-4d0a-a2ce-1c209c093c44 --> [](288abe66-c398-4d0a-a2ce-1c209c093c44) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
