Add instructional dialog for reporting issues #68
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new dialog describing the recommended methods to report any issues discovered in the MAP-Client/Mapping-Tools. This dialog can currently be accessed from within the MAP-Client from the menu options Help -> Report Issue.
The GitHub Issue button opens this page and allows the user to submit a new issue in the MAP-Client GitHub repository. The Wrike Ticket button opens this page which allows the user to request a Wrike ticket for the issue they have encountered.
Note that the description for Wrike users and the button to request a Wrike ticket will only be shown for Mapping-Tools releases of the MAP-Client. @hsorby, currently the code that checks which release variant of the MAP-Client we are using is based on the name of the frozen application that is being executed. I don't believe our PyInstaller script saves the release variant value anywhere that would be available cross-platform, perhaps this is something we might want to do in the future.
The email mentioned in the description (support@sparc.science) is intended as a placeholder until the Mapping-Tools gets its own dedicated support email address.
Some changes have also been made to the message box that pops up when an error is caught by the MAP-Client while executing workflow steps. Specifically, a new button has been added to the pop up that will open the page for a new GitHub issue in the MAP-Client repository. This button opens the same page as the GitHub Issue button in the Issue Reporting dialog described above, but will additionally auto-fill the issue description with the error message caught by the MAP-Client to save the user copying this themselves.