mgr/dashboard: report bugs/improvements/feedback
- Cluster admin may get their Ceph Tracker API key and configure it in the dashboard (CLI, UI -> Cluster -> Mgr Modules -> Dashboard).
- A Ceph Tracker account is needed (see open points).
- Help menu could include a "Report/Send feedback..." entry.
- If no API key has been configured, a modal should point users to the Ceph Tracker account creation and explain the API key (or points to the Ceph Docs section describing this procedure).
- "Report/Send feedback..." modal should expose the minimal set of fields required to fill up a Ceph-Dashboard Tracker Issue (e.g.: summary, description, severity).
- Everything else should be auto-filled: tracker type (issue -> bug, suggestion -> feature, ...), affected Ceph version, category (mapping current Dashboard page to existing Tracker categories).
- Recent pop-up error notifications could/should? be attached to the report.
- Optionally a screenshot can be taken or attachments can be added.
- Ceph Tracker accounts require (for the time being) to be individually approved to avoid past spamming episodes. By forcing Ceph-dashboard users to wait for their accounts to be manually approved could be tiresome. Is there any effective Captcha to allow automated creation?
- Contextual "report issue/feedback"? (on mouse-over? right-click?)
- Add Web Analytics support (would it require explicit approval?). Apart from the Google Analytics , there exist different 'Open Source' analytic frameworks (e.g.: http://www.openwebanalytics.com/, https://matomo.org/, ...).
#2 Updated by Ernesto Puerta about 1 year ago
- Bug or Feature (dropdown)
- Project -> Component (Ernesto to provide a shortlist of components to display)
- Severity: Critical, major, minor. (dropdown)
- Subject (free-form text)
- Description (free-form text)
- Affected version (auto-guess from Ceph? Retrieve from Redmine API. Discard old versions: v0.*) (drop-down with an auto-guessed pre-selection)
- Source [Internal]: "Dashboard Report" (ask DavidG)
- Clicks on the report issue
- If not API Key is registered, "please enter your Ceph Tracker API Key" (with a link to https://tracker.ceph.com/my/api_key).
- "If not registered, please sign up in Ceph Tracker <url>"
- API key will be validated before moving on
- Detect API Key validity on Form loading
- If not valid, redirect to the Wizard (informing "Registered API Key is no longer valid")
- Provide CLI command (e.g.:
ceph dashboard set-ceph-tracker-api-key <new_key>)
- Front-end to Back-end (service via PUT)
- Back-end to Ceph (https://docs.ceph.com/en/latest/mgr/modules/#kv-store)
#3 Updated by Ernesto Puerta about 1 year ago
Shreya, this is the feedback collected from your demo:
- Josh: release shared public key to allow any user anonymously report issues.
- Check with David about spamkillers.
- Sage: extend the description field and, after creating the issue, display a link to the trackers.
- Yaarit: Source to indentify users (CLI, Dashboard).
- Sage: fill up 'Affected versions'.
- Prepopulate description field with: 'expected behavior', 'actual behavior', 'steps to reproduce'
- Nizam: "dashboard feedback create" vs. "create issue"
- Ernesto: create new standalone mgr module (for users not running the Dashboard)?
#5 Updated by Pere Díaz Bou about 1 year ago
Hey one more suggestion :P. What about when creating the issue from the cli you could have the option to open a template file, with your default editor, so you don't have to go the tracker url to complete the description. Basically, simulate something like the command `git commit` that opens `vim`, `nano` or whatever.
#6 Updated by Ernesto Puerta about 1 year ago
#. Blog post
#. Sage: extend the description field and, after creating the issue, display a link to the trackers.
#. Prepopulate description field with: 'expected behavior', 'actual behavior', 'steps to reproduce'
#. Nizam: "dashboard feedback create" vs. "create issue"
#. Ernesto: create new standalone mgr module (for users not running the Dashboard)?
#. Pere: open a CLI editor for filling up the description (maybe with a template too).
#. Yaarit: Source to indentify users (CLI, Dashboard).
#. Sage: fill up 'Affected versions'.