Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-16754

User manuals for Firefly and the Portal application

    Details

    • Story Points:
      20
    • Sprint:
      SUIT Sprint 2019-02, SUIT Sprint 2019-03, SUIT Sprint 2019-04, SUIT Sprint 2019-05, SUIT Sprint 2019-07, SUIT Sprint 2019-08
    • Team:
      Science User Interface
    • Urgent?:
      No

      Description

      Two user manuals should be produced, one for Firefly's core features, and one for the Portal application (previously known as SUIT).

      The Firefly manual is a subset of SUIT manual. 

        Attachments

          Activity

          Hide
          gpdf Gregory Dubois-Felsmann added a comment - - edited

          A Firefly user manual will be produced out of the Firefly online help system, which has very recently been extensively revised. Under the DM-10 freeze, this will be the result of work at IPAC that is largely aimed at other IPAC users, so many of the examples, etc., in the document will be IRSA-centric. If Portal work is restarted, there would be time to refine the documentation to make it more site-agnostic.

          Some technical work will be required to determine how best to serve the user manual - only through the Portal application's online help system, or also through standard project documentation tooling.

          A full Portal application user manual, which would include, for instance, extensive Rubin/LSST-specific screen shots and examples, will not be able to be produced under DM-10. However, a brief supplement to the Firefly user manual can be provided that provides essential information on what is in the Portal that goes beyond what is in "vanilla" Firefly.

          Most likely this supplementary document will be issued within the LTD system.

          Show
          gpdf Gregory Dubois-Felsmann added a comment - - edited A Firefly user manual will be produced out of the Firefly online help system, which has very recently been extensively revised. Under the DM-10 freeze, this will be the result of work at IPAC that is largely aimed at other IPAC users, so many of the examples, etc., in the document will be IRSA-centric. If Portal work is restarted, there would be time to refine the documentation to make it more site-agnostic. Some technical work will be required to determine how best to serve the user manual - only through the Portal application's online help system, or also through standard project documentation tooling. A full Portal application user manual, which would include, for instance, extensive Rubin/LSST-specific screen shots and examples, will not be able to be produced under DM-10 . However, a brief supplement to the Firefly user manual can be provided that provides essential information on what is in the Portal that goes beyond what is in "vanilla" Firefly. Most likely this supplementary document will be issued within the LTD system.

            People

            • Assignee:
              gpdf Gregory Dubois-Felsmann
              Reporter:
              xiuqin Xiuqin Wu [X] (Inactive)
              Watchers:
              Emmanuel Joliet, Gregory Dubois-Felsmann, Trey Roby
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:

                Summary Panel