Task #10784 (closed)
Opened 11 years ago
Closed 9 years ago
Server docs for graphs (delete/chgrp)
Reported by: | jamoore | Owned by: | jamoore |
---|---|---|---|
Priority: | minor | Milestone: | 5.x |
Component: | Documentation | Version: | 5.1.0 |
Keywords: | n.a. | Cc: | fs@… |
Resources: | n.a. | Referenced By: | n.a. |
References: | n.a. | Remaining Time: | n.a. |
Sprint: | n.a. |
Description
Mid-level developer docs are missing for the graph, chgrp, delete, etc packages. While working on this subsystem, the following could be added:
- Sphinx page describing the graph loading of the server
- Graffle of the types of data involved
- explanation of what delete mean. When does an image disapper? When does it fall under "orphan"?
Change History (7)
comment:1 Changed 11 years ago by jamoore
- Sprint changed from FS demo 4.1 to FS demo 4.2
comment:2 Changed 11 years ago by jamoore
- Sprint changed from FS demo 4.2 to FS demo 4.x
comment:4 Changed 9 years ago by mtbcarroll
- Milestone changed from 5.x to 5.0.0-beta1
Certainly there are *some* docs for the new implementation, like http://www.openmicroscopy.org/site/support/omero5.1/developers/Server/ObjectGraphs.html, and I do plan to add some rules comments in my work on https://trello.com/c/Ryvi7Cra/194-review-graph-traversal-rules that may bear on questions like when something is orphaned. Josh, what are your thoughts on what's still missing, if anything?
comment:5 Changed 9 years ago by mtbcarroll
- Milestone changed from 5.0.0-beta1 to 5.x
- Sprint FS demo 4.x deleted
Bah, I didn't change the milestone.
comment:6 Changed 9 years ago by jamoore
This was written priori to your/Mark's rewrite. I'd assume the existing cards probably cover anything I was thinking of. A graffle/visual would be nice, but that probably goes for all of our developer docs, and they're expensive to maintain. Ok if you want to close.
comment:7 Changed 9 years ago by mtbcarroll
- Resolution set to fixed
- Status changed from new to closed
+1
Discussed with Mark. This will be re-addressed during the work on #10890