iop
/
superset
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: pointers to plugins blog post (#10251) 

* docs: pointers to plugins blog post

* fix build
This commit is contained in:
Maxime Beauchemin 2020-07-27 22:46:37 -07:00 committed by GitHub
parent 98437fb3c9
commit 5e93f00a53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -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.

1
README.md
View File

@ -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/)

19
docs/faq.rst
View File

@ -232,7 +232,7 @@ How can i configure OAuth authentication and authorization?
-----------------------------------------------------------
You can take a look at this Flask-AppBuilder `configuration example
<https://github.com/dpgaspar/Flask-AppBuilder/blob/master/examples/oauth/config.py>`_.
<https://github.com/dpgaspar/flask-appbuilder/blob/master/examples/oauth/config.py>`_.
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 <https://github.com/apache/incubator-superset/issues/7259>`_ 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 <https://swagger.io/>`_
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... <https://preset.io/blog/2020-07-02-hello-world/>`_ blog post.