Task #10048 (closed)
Opened 7 years ago
Closed 6 years ago
Bulk Annotations display
| Reported by: | jburel | Owned by: | rkferguson |
|---|---|---|---|
| Priority: | major | Milestone: | OMERO-4.4.7 |
| Component: | Documentation | Version: | n.a. |
| Keywords: | n.a. | Cc: | ux@…, hflynn, wmoore |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
insight and Web now offer support for "bulk annotations" A scenario already exists (screenshots ) required but no documentation.
See https://github.com/openmicroscopy/openmicroscopy/pull/512
Petr: add/update screenshot to scenario then pass it on.
Change History (12)
comment:1 Changed 7 years ago by pwalczysko
comment:2 Changed 7 years ago by pwalczysko
- Owner changed from pwalczysko to hflynn
comment:3 Changed 7 years ago by pwalczysko
@hflynn: Please see scenario https://www.openmicroscopy.org/private/ome-internal/testing_scenarios/BulkAnnotations.html for what should be documented.
comment:4 Changed 7 years ago by hflynn
As far as users are concerned, should there be a new section on https://www.openmicroscopy.org/site/support/omero4/users/client-tutorials/insight/insight-util-scripts.html for this?
Aside from that page, I'm thinking this mostly belongs in the developer docs on scripting, suggesting I am not the person to own this ticket. Also, now I look at them, the scripting pages in the developer section are a mess, with some incorrect sphinx formatting meaning there are broken internal links for a start. Maybe we should make a new ticket for reviewing the scripting docs as a whole?
comment:5 Changed 7 years ago by jburel
New section should probably go under tutorials since the user will probably not run the script himself/herself
Agree that
The scripting section needs to be reviewed. A new ticket will be clearer
comment:6 Changed 7 years ago by hflynn
Is this a job for Gus then?
I'll make a new ticket for the developer scripting docs now.
comment:7 Changed 7 years ago by hflynn
- Owner changed from hflynn to rkferguson
comment:8 Changed 7 years ago by jburel
as it stands the functionality is in the early stage. we could have a page to see what is doable will be useful. We could reuse some of the screenshots made by Petr
comment:9 Changed 7 years ago by rkferguson
If you are talking about updating training materials, for consistency I need to be able to do screenshots using Warlock.
If you are talking about making a tutorial, that is quite different from training material and I think we need a broader discussion about the aims, scope and what approach to take to online tutorials.
If you are talking about updating an existing tutorial, which one do you have in mind?
comment:10 Changed 7 years ago by hflynn
Training material going into the user docs contains updated scripts section but only for exporting scripts. We need to decide if we want to keep all the other scripting info in the developer section or add an advanced tutorial for other functionality to the user docs. May be best to do this after Will has reviewed the developer scripting docs.
comment:11 Changed 7 years ago by hflynn
Just chatted to Will about this. If we want to add this functionality to the User docs, there would need to be a proper tutorial explaining how to format the .csv files etc. No point doing this if the script isn't going to be included in the release though - if users have to ask their sysadmin to install the script, then it really belongs in the developer section (maybe under a new 'features in development' section?). So I guess it comes down to whether we are going to start shipping this script and if it's worth Gus spending the time writing a whole new tutorial for it at the moment or not?
comment:12 Changed 6 years ago by hflynn
- Resolution set to fixed
- Status changed from new to closed
Decision made with JM and Gus that this functionality is too specialised for coverage in user docs to be necessary at this stage. So closing now testing scenario has been completed.
Fixed within PR https://github.com/openmicroscopy/ome-internal/pull/17.