appuio / cloud-portal

APPUiO Cloud Portal (Web Frontend)
Apache License 2.0
5 stars 0 forks source link

Inline Help #103

Closed tobru closed 1 year ago

tobru commented 2 years ago

Summary

As APPUiO Cloud Portal user I want to quickly get help So that I get the information I need to make the best out of the Portal.

Context

The Portal offers various possibilities which bring more value if they are described directly in the Portal. We should have a way to add inline help with an optional pointer to the full-blown end-user documentation at docs.appuio.cloud (or where ever it resides).

Out of Scope

Further links

No response

Acceptance Criteria

No response

Implementation Ideas

Help icon on the appropriate places: When hovering over it, display a short description / help message and offer a link to the full-blown documentation.

tobru commented 2 years ago

What I've seen on other web applications is a (?) right besides the title of a field or of a section which brings the user to the matching documentation.

akosma commented 2 years ago

What I've seen on other web applications is a (?) right besides the title of a field or of a section which brings the user to the matching documentation.

Like we've done for the Control Panel. We can add this as a separate Antora module with some kind of mnemotechnic code between (?) buttons and page filenames.

tobru commented 1 year ago

This hasn't progressed and refined, so I'll close it for now. We can redo this issue once it gets prioritized again.