search

arkOScloud / genesis

Graphical server management app for arkOS
https://arkos.io
GNU General Public License v3.0
278 stars 44 forks source link

In-App Help #477

Open heinzK1X opened 10 years ago

heinzK1X commented 10 years ago

I miss a feature for website plugins. When I implemented Etherpad and DokuWiki, I felt that I should be able to give the user additional hints on how to proceed once the plugin is installed. I also played with GitWeb.. there, for example, the user should be able to easily access information on how and where to set up the git repository, and not having to consult other docs or even to search the web for a guideline.

For this it would be nice to have a help symbol in the row of symbols under the website, maybe even as the first symbol. On click it would open an overlay, just like the config button.

The layout could be provided as help.xml in the layout folder. If help.xml is found, the help button is shown, otherwise not.

What do you think? If you like it, I could try to implement this.

peakwinter commented 10 years ago

Great idea! Plugins have this sort of infrastructure presently, but webapps do not yet have it. I will take a look shortly.

peakwinter commented 7 years ago

The scope of this issue has been expanded to include app-wide help dialogs. This should use a dedicated Ember component that loads a partial depending on the active route.