Warning: Can't synchronize with repository "(default)" (/home/git/ome.git does not appear to be a Git repository.). Look in the Trac log for more information.
Notice: In order to edit this ticket you need to be either: a Product Owner, The owner or the reporter of the ticket, or, in case of a Task not yet assigned, a team_member"

Task #10931 (closed)

Opened 11 years ago

Closed 11 years ago

FS lite import docs

Reported by: hflynn Owned by: cblackburn
Priority: critical Milestone: 5.0.0-beta1
Component: Documentation Version: 5.0.0-beta1
Keywords: n.a. Cc: fs@…
Resources: n.a. Referenced By: n.a.
References: n.a. Remaining Time: n.a.
Sprint: FS demo 4.x

Description

Developer documentation on importing needs updating to reflect .fs lite workflow.

Helen to do the introductory text and then pass on to someone else to write the technical description (either directly into docs, or update technical description gdoc)

Change History (12)

comment:1 Changed 11 years ago by hflynn

I've done some initial work on this branch https://github.com/hflynn/ome-documentation/tree/fs_dev/omero/developers - so far just introductory blurb and headings from the gdoc to illustrate what the technical description might cover. Not sure what the best way forward is - shall I open a PR now so we can get this merged and then someone else can add the technical details? Or is the gdoc https://docs.google.com/document/d/15zpLHsXhvSbCa5hLIn9Mwj3spCq-2wvN9QXLZCao3ZU/edit# still relevant enough that it is worth me adding this stuff to sphinx now and someone editing it in the docs rather than updating the gdoc? Also not sure if more work is needed on the existing Import Library file.

comment:2 Changed 11 years ago by jburel

  • Cc fs@… added; jamoore jburel bpindelski mtbcarroll cblackburn removed

comment:3 Changed 11 years ago by jamoore

Comments:

  • I wouldn't try migrating the google doc to sphinx yet
  • branch certainly seems fine. Opening a PR at the moment would leave empty headers, but that shouldn't matter for omero4-develop. Alternatively, someone could take over your branch and add content.

Is it clear which sections to start flushing out next?

comment:4 Changed 11 years ago by hflynn

Adding some sections from gdoc which are more complete. Will open a PR tomorrow. Remaining sections for Fs-lite import doc will be revisited 31st May in the hope @jamoore will have had time to update them by then. If not, will come up with a plan to pass ticket to various people in turn to complete remaining sections.

comment:5 Changed 11 years ago by hflynn

  • Owner changed from hflynn to cblackburn

PR opened for initial work https://github.com/openmicroscopy/ome-documentation/pull/375
Have made text sections from the gdoc dark red to indicate which have been transferred. Left server-side sequence for @jamoore to work on further next week and didn't move import workflow because I think it is out of date in that it didn't seem to mesh with what Petr demo'ed today (this is possibly because there is a difference between how things look client-side and what is actually happening behind the scenes, but even so I thought it would be nice if this related the two view points).

Passing ticket on to Colin for remaining work on FSlite.txt once this PR is merged.

comment:6 Changed 11 years ago by hflynn

  • Sprint set to FS Demo 4.3

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 jamoore

  • Sprint changed from FS demo 4.4 to FS demo 4.x

Pushing for later review

comment:9 Changed 11 years ago by hflynn

  • Milestone changed from OMERO-5 to Testing
  • Sprint changed from FS demo 4.x to Testing and Docs (2)
  • Version set to 5.0.0-beta1

File in need of updating/finishing off is now omero/developers/ManagedRepository/ManagedRepository.txt - we could really do with this completing over the summer if possible so I've added it to the August sprint.

comment:10 Changed 11 years ago by jburel

  • Milestone changed from Testing and Docs to OMERO-5
  • Sprint changed from Testing and Docs (2) to FS demo 4.x

Colin being away, moving to sprint FS demo 4.x.
It will be great if that could be sorted soonish. To be discussed with Colin next week when he gets back.

comment:11 Changed 11 years ago by hflynn

With https://github.com/openmicroscopy/ome-documentation/pull/448 merged, is the work on this ticket finished, or did you have some further tidying you wanted to use this to keep track of @cblackburn?

comment:12 Changed 11 years ago by cblackburn

  • Resolution set to fixed
  • Status changed from new to closed

Closing after the merging of the above PR.

Note: See TracTickets for help on using tickets. You may also have a look at Agilo extensions to the ticket.

1.3.13-PRO © 2008-2011 Agilo Software all rights reserved (this page was served in: 0.71653 sec.)

We're Hiring!