Task #10793 (closed)
Opened 11 years ago
Closed 9 years ago
Fileset description/diagram
| Reported by: | jamoore | Owned by: | hflynn |
|---|---|---|---|
| Priority: | critical | Milestone: | 5.1.1 |
| Component: | Documentation | Version: | 5.0.8 |
| Keywords: | n.a. | Cc: | fs@…, hflynn, rleigh |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | n.a. |
Description
A diagram of what a fileset, in all its complexity is, is needed. Key is to get across how brittle they are, i.e. "NO RENAMING" and "AT YOUR OWN RISK"
Change History (14)
comment:1 Changed 11 years ago by mtbcarroll
comment:2 Changed 11 years ago by mtbcarroll
- Component changed from General to Documentation
- Owner set to mtbcarroll
I'll attempt to have some ideas this week with pencil and paper, though the challenge seems to be more one of visual communication than technical details.
comment:3 Changed 11 years ago by mtbcarroll
- Sprint set to FS Demo 4.3
comment:4 Changed 11 years ago by mtbcarroll
- Status changed from new to accepted
I'll try to sketch something about and hopefully Andrew can help with OmniGraffling? it or whatever.
comment:5 Changed 11 years ago by mtbcarroll
- Cc ajpatterson added
comment:6 Changed 11 years ago by mtbcarroll
- Owner mtbcarroll deleted
I've probably done about as much as I can here for the meantime. Thank you to Andrew, Josh, Melissa for their contributions. Initial draft of text and diagram now in ome/team/hflynn/fs-paper/trac-10793-fileset-diagram/. Figuring that this is for the paper, I avoided reusing any text from http://www.openmicroscopy.org/site/support/omero5-staging/developers/Modules/Delete.html#delete-multi-file-images-and-image-sets
comment:7 Changed 11 years ago by jburel
- Sprint changed from FS Demo 4.3 to FS demo 4.4
Moved from sprint FS Demo 4.3
comment:8 Changed 11 years ago by mtbcarroll
I left some suggested to-do's noted in that above directory, in diagram-todo.text, viz.,
The file formats chosen have public examples in data_repo/public (well, DICOM doesn't, though I expect that we have some single-file to single-image example publicly usable somewhere though for some popular file format if not DICOM). The images and filenames in the diagram should be changed to match something actually publishable. And, maybe there's some TM mark or similar that should be used in some of the file format names.
comment:9 Changed 11 years ago by jamoore
- Owner set to wmoore
Passing to Will as discussed in standup.
comment:10 Changed 11 years ago by wmoore
- Cc ajpatterson removed
- Owner changed from wmoore to ajpatterson
Hi Andrew - I've put my Fileset omni-graffle in squig/team/hflynn/figures..
If you could have a go at making it nice, that would be great, Thanks.
comment:11 Changed 11 years ago by jamoore
- Sprint changed from FS demo 4.4 to FS demo 4.x
Note: there are versions of this now both with ascii-art and with screenshots in a graffle. All of this should be compared and evaluated before anything new is created. Pushing.
comment:12 Changed 9 years ago by ajpatterson
- Owner changed from ajpatterson to hflynn
- Version set to 5.0.8
comment:13 Changed 9 years ago by jamoore
- Milestone changed from 5.x to 5.1.1
- Sprint FS demo 4.x deleted
Would be good to have along with perhaps pyramid docs in the 5.1 line.
comment:14 Changed 9 years ago by hflynn
- Resolution set to fixed
- Status changed from accepted to closed
https://github.com/openmicroscopy/ome-documentation/pull/1193
Will deal with any further work needed via the PR or https://trello.com/c/zd9PQRlo/232-better-fs-docs-with-diagrams
I don't usually get on too well with GUI image-making if you want them to actually look good (I usually use Basser Lout or LaTeX TikZ or something to make EPS or PDF) but I can certainly help with understanding filesets. (I assume the "no renaming" is more about the files, but then the OriginalFile entry would break anyway with or without filesets?)