Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mobile: Plugin support: Simplify reporting plugin issues #10319

Conversation

personalizedrefrigerator
Copy link
Collaborator

@personalizedrefrigerator personalizedrefrigerator commented Apr 16, 2024

Summary

This pull request is part of a follow-up to the "show plugin description banners" pull request (see comment). It does the following:

  • Adds an "about" screen for each plugin.
    • To support this, refactors the logic for displaying a modal with a close button out of PluginPanelViewer.
  • Includes information about how to report bugs in a plugin on that about screen.

NOTES:

  • Currently, the "report on Joplin forum" option auto-fills a post in the "Support" category (see screenshot below for details).
  • This pull request is being opened in part as to discuss UI design for this feature. Feedback is welcome 🙂 .

Screenshots

A grid of screenshots: Includes light and darkmode screenshots of two plugins: Outline and create and goto at tags and pound notebooks. Each has "About" and "report fraudulent plugin" links. Only outline has a "report an issue" link

Testing

  1. Install 2 or more plugins (outline and create and goto #tags and @notebooks)
  2. Verify that installed plugins have an "info" button on the right of their titles.
  3. Verify that clicking the "info" button (test for outline) shows a screen with the plugin's title, author, description, and link buttons.
  4. Verify that clicking "About" opens the plugin website page for a plugin.
  5. Open a plugin with a GitHub repository's info screen (e.g. the outline plugin). Verify that clicking "report an issue" opens the GitHub issues page for outline.
  6. Verify that clicking "report fraudulent plugin" opens Joplin's page for reporting security advisories.

This has been tested successfully on a physical Android device. An earlier version of this pull request was also tested on an iOS simulator.

@laurent22
Copy link
Owner

Thanks for this update but I feel that may be too many support links. I would be tempted to leave just one - the one to the author public repository. This is because that should be the first point of contact if there's a problem, and then the author can decide that they can't fix it and report it to us. But the user would not know that.

As for reporting a security issue, I don't know if that should be in there since it will be very rarely needed. So much that the day there's actually a security issue with a plugin, the user might not even think there's a link for this and contact us directly instead anyway.

@personalizedrefrigerator
Copy link
Collaborator Author

personalizedrefrigerator commented Apr 17, 2024

Thanks for this update but I feel that may be too many support links. I would be tempted to leave just one - the one to the author public repository. This is because that should be the first point of contact if there's a problem, and then the author can decide that they can't fix it and report it to us. But the user would not know that.

One alternative could be to link to a page on the Plugin Discovery Website. For example, https://joplinapp.org/plugins/report-issue.html?plugin=com.whatever.quick-links,app-info=<<app-info-here>>.

This page could then include a list of instructions similar to:

  1. Search for similar issues on the issue tracker for the plugin. Unless the author has disabled it, [an issue tracker can be found here] (link).
  2. Search for similar issues on the [joplin forum] (link, perhaps with a default search query)
    • Maybe don't include this. We might get an overwhelming number of reports.
  3. Report the issue on the plugin's issue tracker. It may be helpful to include the following block with app information:
    Joplin 3.0.1 (dev, android)
    
    Client ID: someuuidhere
    Sync version: 3
    Profile version: 47
    Keychain supported: no
    
    History panel v1.0.0
    Quick Links v2.3.4
    

It might also make sense to include instructions for what to do if a plugin is unmaintained and broken on mobile and/or desktop. (If this is the case, we may want to mark the plugin as only supporting one platform using manifestOverrides.json on the plugin repository).

Thank you for the feedback!

@laurent22 laurent22 merged commit aec77b5 into laurent22:dev Apr 25, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants