From 5e93f00a53ef30c3c7dbe60f11ca83c2ac44a302 Mon Sep 17 00:00:00 2001 From: Maxime Beauchemin Date: Mon, 27 Jul 2020 22:46:37 -0700 Subject: [PATCH] docs: pointers to plugins blog post (#10251) * docs: pointers to plugins blog post * fix build --- CONTRIBUTING.md | 8 ++++++++ README.md | 1 + docs/faq.rst | 19 +++++++++++++------ 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6c7ff8bb..0640aecff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -840,6 +840,14 @@ When `superset-ui` packages are linked with `npm link`, the dev server will auto Note that every time you do `npm install`, you will lose the symlink(s) and may have to run `npm link` again. + +### Visualization Plugins + +The topic of authoring new plugins, whether you'd like to contribute +it back or not has been well documented in the +[So, You Want to Build a Superset Viz Plugin...](https://preset.io/blog/2020-07-02-hello-world/) blog post + + ### Adding a DB migration 1. Alter the model you want to change. This example will add a `Column` Annotations model. diff --git a/README.md b/README.md index cbc2ea430..acbf60d1a 100644 --- a/README.md +++ b/README.md @@ -131,3 +131,4 @@ how to set up a development environment. * [Docker image](https://hub.docker.com/r/preset/superset/) * [Youtube Channel](https://www.youtube.com/channel/UCMuwrvBsg_jjI2gLcm04R0g) * [May 15, 2020: Virtual Meetup Recording. Topics: 0.36 Overview, Committers Self-Intro, Roadmap](https://www.youtube.com/watch?v=tXGDmqjmcTs&t=20s) +* [So, You Want to Build a Superset Viz Plugin...](https://preset.io/blog/2020-07-02-hello-world/) diff --git a/docs/faq.rst b/docs/faq.rst index 07dda0c22..6f9144de7 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -232,7 +232,7 @@ How can i configure OAuth authentication and authorization? ----------------------------------------------------------- You can take a look at this Flask-AppBuilder `configuration example -`_. +`_. How can I set a default filter on my dashboard? ----------------------------------------------- @@ -321,14 +321,14 @@ Does Superset offer a public API? Yes, a public REST API, and the surface of that API formal is expanding steadily. Some of the original vision for the collection -of endpoints under `/api/v1` was originally specified in -[SIP-17](https://github.com/apache/incubator-superset/issues/7259) and +of endpoints under ``/api/v1`` was originally specified in +`SIP-17 `_ and constant progress has been made to cover more and more use cases. -The API available is documented using [Swagger](https://swagger.io/) +The API available is documented using `Swagger `_ and the documentation -can be made available under `/swagger/v1` by enabling -the `FAB_API_SWAGGER_UI = True` configuration flag. +can be made available under ``/swagger/v1`` by enabling +the ``FAB_API_SWAGGER_UI = True`` configuration flag. There are other undocumented [private] ways to interact with Superset programmatically that offer no guarantees and are not recommended but @@ -337,3 +337,10 @@ may fit your use case temporarily: - using the ORM (SQLAlchemy) directly - using the internal FAB ModelView API (to be deprecated in Superset) - altering the source code in your fork + + +How do I create a new visualization? +------------------------------------ + +The process has been documented in the +`So, You Want to Build a Superset Viz Plugin... `_ blog post.