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

Write a how-to document for PipelineTasks

    XMLWordPrintable

    Details

    • Story Points:
      20
    • Sprint:
      DRP F19-5, DRP F19-6 (Nov), DRP S20-2 (Jan), DRP S20-3 (Feb), DRP S20-5 (Apr), DRP S20-6 (May), DRP F20-1 (June), DRP F20-2 (July), DRP F20-3 (Aug), DRP F20-5 (Oct), DRP S21a (Dec Jan), DRP S21b
    • Team:
      Data Release Production
    • Urgent?:
      No

      Description

      Create a comprehensive how-to for writing PipelineTasks, covering some bits of the gen3 middleware as needed.

        Attachments

          Issue Links

            Activity

            Hide
            tjenness Tim Jenness added a comment -

            Will this include a "how to use pipetask to execute pipelines" or should that be a separate document?

            Show
            tjenness Tim Jenness added a comment - Will this include a "how to use pipetask to execute pipelines" or should that be a separate document?
            Hide
            nlust Nate Lust added a comment -

            Here is the review we talked about. You have looked at this once a while ago, and indeed the pull request is still up there. But it has been reworked and converted to rst. If you could review the rst version I would appreciate it. I have not deleted the old markdown version yet, as I have shared the github link around and dont want to remove it until the rst is up.

            Show
            nlust Nate Lust added a comment - Here is the review we talked about. You have looked at this once a while ago, and indeed the pull request is still up there. But it has been reworked and converted to rst. If you could review the rst version I would appreciate it. I have not deleted the old markdown version yet, as I have shared the github link around and dont want to remove it until the rst is up.
            Hide
            jsick Jonathan Sick added a comment -

            I've finished my review. The summary is https://github.com/lsst/pipe_base/pull/102#pullrequestreview-562972083

            As I said there, so long as the basic rst syntax issues are taken care of and the document compiles with the full stack (following the instructions at https://developer.lsst.io/stack/building-pipelines-lsst-io-locally.html) then you can go ahead and merge this without necessarily taking care of all my suggested edits (if your time doesn't permit). We can always revisit the document as time goes on and continue to improve it as more pipeline task documentation is created.

            Show
            jsick Jonathan Sick added a comment - I've finished my review. The summary is https://github.com/lsst/pipe_base/pull/102#pullrequestreview-562972083 As I said there, so long as the basic rst syntax issues are taken care of and the document compiles with the full stack (following the instructions at https://developer.lsst.io/stack/building-pipelines-lsst-io-locally.html)  then you can go ahead and merge this without necessarily taking care of all my suggested edits (if your time doesn't permit). We can always revisit the document as time goes on and continue to improve it as more pipeline task documentation is created.
            Hide
            tjenness Tim Jenness added a comment -

            Nate Lust there's a huge amount of content on this ticket that people can't see. How do we get it unblocked?

            Show
            tjenness Tim Jenness added a comment - Nate Lust there's a huge amount of content on this ticket that people can't see. How do we get it unblocked?
            Hide
            nlust Nate Lust added a comment -

            There are things with this documentation that will need to be addressed over time, but enough of the issues were addressed that it should not wait to be perfect. I fixed a lot, and made sure it built correctly with sphinx and merged it in.

            Show
            nlust Nate Lust added a comment - There are things with this documentation that will need to be addressed over time, but enough of the issues were addressed that it should not wait to be perfect. I fixed a lot, and made sure it built correctly with sphinx and merged it in.

              People

              Assignee:
              nlust Nate Lust
              Reporter:
              nlust Nate Lust
              Reviewers:
              Jonathan Sick
              Watchers:
              Jonathan Sick, Michelle Gower, Nate Lust, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.