jbrowse-components icon indicating copy to clipboard operation
jbrowse-components copied to clipboard

Provide users with extra docs on-plugin-install and make filters for plugin store

Open cmdcolin opened this issue 4 years ago • 0 comments
trafficstars

The plugin store currently offers the ability to one-click install all plugins

  • There may be some plugins that are not really usable on web if they are desktop specific
  • There are also some plugins that may not really be usable in a one-click situation (requires config editing)
  • There may also be some detailed procedure needed to find out how to use (e.g. navigating to specific menu to pop up a view)

It may be useful to add filters, so desktop plugins are not shown on web

It may also be useful to popup a little docs, or provide a link to the docs, after install

Metadata would be in the plugin store's plugins.json file

Example json attributes

desktop:true/false web:true/false pnp:false // "plug and play" e.g. can be used without hand editing config

example:non-admin filter settings on web pnp:true web:true

Therefore, a desktop-only plugin would have web:false and be filtered out

May need version range filtering

Extra: popup a doc location, which helps orient users once they install

docsLocation: "http://mysite.com/plugindocs"

cmdcolin avatar Jun 23 '21 18:06 cmdcolin