Disable manual topic editing in the UI for GitHub App entries #1859
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1859 +/- ##
===========================================
- Coverage 40.53% 40.47% -0.06%
===========================================
Files 365 366 +1
Lines 11283 11359 +76
Branches 2896 2913 +17
===========================================
+ Hits 4574 4598 +24
- Misses 4407 4448 +41
- Partials 2302 2313 +11 ☔ View full report in Codecov by Sentry. |
| <span | ||
| ><strong | ||
| matTooltip="Short description of the {{ entryType$ | async }}, entered manually in the {{ | ||
| workflow?.mode === WorkflowType.ModeEnum.DOCKSTOREYML ? '.dockstore.yml' : 'UI' |
There was a problem hiding this comment.
This message might be a little confusing for .dockstore.yml users that have previous entered a topic in the UI, because it'll tell them that it was entered in the .dockstore.yml.
There was a problem hiding this comment.
Interesting you bring that up, I suppose this feature should come with some type of notification to .dockstore.yml users that they should modify their .dockstore.yml to include topics that they might have added in the UI. The webservice PR dockstore/dockstore#5713 won't overwrite existing topicManual if they don't do this so we won't lose it, but they should know about it
There was a problem hiding this comment.
FWIW, I find tooltips are good to have, but half the users don't know to look for them (I often forget myself on other websites), and they shouldn't be relied as the sole way of conveying key info. Could you convey the info some other way as well? Ideas:
- Next to/below the Topic Manual label, have some text saying the text must be edited in the .dockstore.yml.
- When the user clicks the Edit button, a dialog pops saying edit the .dockstore.yml. I'm not 100% wild about this, but this is a brainstorm.
These are suggestions, not blocking, and it could stay the way it is as I suspect most users won't run into this.
There was a problem hiding this comment.
FWIW, I find tooltips are good to have, but half the users don't know to look for them (I often forget myself on other websites), and they shouldn't be relied as the sole way of conveying key info
I lean towards keeping it as is because this pattern exists for the other fields on the info tab. If we decide to re-design how to display tooltip info, we can migrate them all at once so the UI is consistent
There was a problem hiding this comment.
This message might be a little confusing for .dockstore.yml users that have previous entered a topic in the UI, because it'll tell them that it was entered in the .dockstore.yml.
I specified in the disabled Edit button for GitHub app entries that editing in the UI is deprecated
| <span | ||
| ><strong | ||
| matTooltip="Short description of the {{ entryType$ | async }}, entered manually in the {{ | ||
| workflow?.mode === WorkflowType.ModeEnum.DOCKSTOREYML ? '.dockstore.yml' : 'UI' |
There was a problem hiding this comment.
FWIW, I find tooltips are good to have, but half the users don't know to look for them (I often forget myself on other websites), and they shouldn't be relied as the sole way of conveying key info. Could you convey the info some other way as well? Ideas:
- Next to/below the Topic Manual label, have some text saying the text must be edited in the .dockstore.yml.
- When the user clicks the Edit button, a dialog pops saying edit the .dockstore.yml. I'm not 100% wild about this, but this is a brainstorm.
These are suggestions, not blocking, and it could stay the way it is as I suspect most users won't run into this.
|
Kudos, SonarCloud Quality Gate passed!
|
Description
This PR goes with dockstore/dockstore#5713 and disables manual topic editing in the UI for GitHub app entries since they should be updating it in the .dockstore.yml instead. Topic selection is left as is, so the user can still change the selection for a GitHub app entry.
Also updated some tooltips for the topics.
Review Instructions
In addition to the instructions in dockstore/dockstore#5713, verify that the
Editbutton for editing manual topics is disabled for GitHub App entries.Issue
dockstore/dockstore#5625
DOCK-2444
Security
If there are any concerns that require extra attention from the security team, highlight them here.
Please make sure that you've checked the following before submitting your pull request. Thanks!
npm run buildmarkdown-wrappercomponent, which does extra sanitizationnpm auditand ensure you are not introducing new vulnerabilities