Task #2101 (closed)
Opened 14 years ago
Closed 8 years ago
Bug: Copy all documentation from ome.api.* to omero.api.*
| Reported by: | jamoore | Owned by: | |
|---|---|---|---|
| Priority: | critical | Milestone: | Testing2 |
| Component: | API | Version: | 4.4.8 |
| Keywords: | n.a. | Cc: | jburel, rleigh, sbesson |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | 0.0d |
| Sprint: | n.a. |
Description (last modified by jmoore)
Also be sure to update the OmeroDevelopment page with tips & rules for how to document.
Change History (17)
comment:1 Changed 14 years ago by jmoore
- Description modified (diff)
comment:2 Changed 14 years ago by jmoore
- Cc ajpatterson jburel added
comment:3 Changed 14 years ago by jmoore
- Sprint 2010-04-02 (6) deleted
comment:4 Changed 14 years ago by jmoore
- Owner set to jmoore
- Sprint set to 2010-06-10 (11)
comment:5 Changed 14 years ago by jburel
- Sprint changed from 2010-06-10 (11) to 2010-06-24 (12)
comment:6 Changed 14 years ago by jmoore
- Component changed from API to Documentation
- Milestone changed from OMERO-Beta4.2 to Unscheduled
- Priority changed from minor to major
- Sprint 2010-06-24 (12) deleted
comment:7 Changed 13 years ago by bwzloranger
Brian: So Josh what tasks should I add to on ticketing these? What do you see as the goal? improving commentary on javaDocs? Site navigation changes? Do you have something in mind or just an overall review?
Josh Moore: There's already a ticket for moving all docs from ome.api.* to omero.api.*
Then a general overview of each of those methods. Has anything changed? Are there tests to show that the method does what the docs say. Then there need to be a small handful of landing pages. When you go to any of those sites, you're somewhat at a loss for where to get started.
comment:8 Changed 12 years ago by jmoore
- Milestone changed from Unscheduled to OMERO-Beta4.4
- Owner jmoore deleted
- Priority changed from major to critical
- Summary changed from Copy all documentation from ome.api.* to omero.api.* to Bug: Copy all documentation from ome.api.* to omero.api.*
See also #4341 (delete documentation): there it is difficult to point users from ome.api.IUpdate to the proper location because it is not in ome.api.IDelete but only omero.api.IDelete. It is definitely time to make the move!
comment:9 Changed 12 years ago by jmoore
- Milestone changed from OMERO-Beta4.4 to OMERO-Beta4.4.1
Don't see us getting to this for the main release. Pushing to 4.4.1 as one of these post-release documentation tickets. If we'd rather have a 4.4.0-DOC milestone, I'm fine with that, too.
comment:10 Changed 12 years ago by jmoore
- Cc rleigh bpindelski sbesson added
Expanding CC for a discussion while we tackle the rest of the docs.
comment:11 Changed 11 years ago by hflynn
Is this ticket still valid now we have the sphinx docs?
comment:12 Changed 11 years ago by jamoore
- Component changed from Documentation to API
Moving this out of the Documentation component. This requires changes to components/blitz/resources/omero/api/*
comment:13 Changed 11 years ago by jamoore
- Milestone changed from OMERO-4.4.9 to Testing2
- Version set to 4.4.8
Pushing yet again, unfortunately. This time moving it to milestone:Testing2 which covers "integration, refactoring, coverage". Perhaps we can handle it there?
comment:14 Changed 10 years ago by jamoore
See also #11763
comment:15 Changed 8 years ago by sbesson
At the moment the omero.api.* pages link to the corresponding ome.api.* via latest redirects. Is this sufficient or do we want to bite the bullet and do the full copy. If so, that might be something we can do as part of OMERO 5.3.0.
comment:16 Changed 8 years ago by jamoore
- Cc cxallan ajpatterson bpindelski removed
The ome.api unfortunately doesn't map 1-1 meaning users will be confused and subtly mislead.
comment:17 Changed 8 years ago by sbesson
- Remaining Time changed from 0.5 to 0
- Resolution set to duplicate
- Status changed from new to closed
Migrated to https://trello.com/b/1t6i9daP/omero-5-3-0
Pushing to unscheduled. Just too many things to do.