BlueBrain / BlueBrain/nexus

How-To: Write and Enable a Nexus Fusion Plugin

Open
#1,483 0 comments 0 reactions 0 assignees View on GitHub
documentation fusion fusion-plugin
Dominant language
Scala
Stars
301
Forks
76
PR merge metrics
No merged PRs in 30d

Description

To ease the development of plugins for users, we should provide an example plugin (e.g. simple image or metadata) in the docs.

- explain what plugins are
- create a code sandbox project for the plugin
- use case/example: data download (from the nexus-web-plugins repo)
- create the react component to satisfy the use case
- build and export the artifacts
- paste the artifacts to the right location (e.g. fusion plugin directory)
- document the process to configure a plugin for a deployed instance
- adapt the plugin manifest
- point to the public nexus plugin repo for the actual plugin and more examples

Let's do it during internal onboarding.

Contributor guide

Open the contributing guide

Research direction

Start by reading the data-download example in the nexus-web-plugins repository and reviewing the existing Fusion plugin directory and deployment configuration. Create an example plugin project, document its React component, build/export steps, manifest changes, installation, and configuration for a deployed instance. Done means the example and onboarding guide cover the full process and point to the public plugin repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
documentation, frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.