search

biigle / core

:large_blue_circle: Application core of BIIGLE
https://biigle.de
GNU General Public License v3.0
12 stars 15 forks source link

New help portal #453

Open mzur opened 2 years ago

mzur commented 2 years ago

Maybe we could replace the manual as primary resource for help with a new "Help" portal (which replaces "Manual" in the top menu). The portal shows links to the community discussion forum (here on GitHub), how to report bugs or request features, the manual, contact details to the instance admins and a new developer documentation section (which would be detached from the manual). This could be implemented together with #161 to improve the manual in general. However, the manual links must stay the same (at least through redirects).

mzur commented 1 year ago

As a first step, I'll implement a new "help" icon in the navbar. Clicking on the icon opens a dropdown with "manual" and "community" (linking to the GitHub discussions). Here we will also place the link to the service rating form as part of our registration as a de.NBI service (the link will be added through a module).

mzur commented 1 year ago

Remove the "manual" link from the main menu once this is finished.

mzur commented 1 year ago

The help portal could also include "workflows" which explain different things you can do with BIIGLE end-to-end. Example workflows:

In contrast to the manual that just describes all features, workflows can teach users how these features can be used together to achieve a specific goal.

The European ELIXIR network is quite interested in collecting workflows like these. Either we use a platform provided by them or our workflows should be registered there somewhere.