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

Add a task index page to pipelines.lsst.io

    XMLWordPrintable

    Details

      Description

      Add a index page for every task in lsst_distrib to https://pipelines.lsst.io.

      This is a simpler version of the process-context-based documentation sections designed in https://dmtn-030.lsst.io/#processing-section, but it's something that is doable now with little effort.

      This index page could either be linked from the homepage, or from a Task framework page.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            John Swinbank what do you think about the Index/Task index pages added in this PR: https://github.com/lsst/pipelines_lsst_io/pull/138

            Show
            jsick Jonathan Sick added a comment - John Swinbank what do you think about the Index/Task index pages added in this PR: https://github.com/lsst/pipelines_lsst_io/pull/138
            Hide
            swinbank John Swinbank added a comment -

            Thanks, Jonathan Sick — this looks great.

            I have a couple of general comments/questions, which I don't think should delay the merger of this ticket.

            • While I can see why you've put this in an “Indices” section, it feels a little bit buried. The tasks are really the algorithmic heart of the Pipelines, and I feel like we ought to be presenting them front-and-center in a “look at all the useful things you can do” kind of a way. In DMTN-030ese, I think that means this sort of listing should be linked from the “Processing” section. Since that section doesn't exist yet, there's obviously not much we can do about it for now!
            • I feel ignorant for asking this, but what should be listed by lsst-configurables? At the moment, it's showing nothing... and it's not obvious to me what it's for. I had a quick look at the Developer Guide and it didn't really help. What did I miss?
            Show
            swinbank John Swinbank added a comment - Thanks, Jonathan Sick — this looks great. I have a couple of general comments/questions, which I don't think should delay the merger of this ticket. While I can see why you've put this in an “Indices” section, it feels a little bit buried. The tasks are really the algorithmic heart of the Pipelines, and I feel like we ought to be presenting them front-and-center in a “look at all the useful things you can do” kind of a way. In DMTN-030ese, I think that means this sort of listing should be linked from the “Processing” section. Since that section doesn't exist yet, there's obviously not much we can do about it for now! I feel ignorant for asking this, but what should be listed by lsst-configurables ? At the moment, it's showing nothing... and it's not obvious to me what it's for. I had a quick look at the Developer Guide and it didn't really help. What did I miss?
            Hide
            jsick Jonathan Sick added a comment -

            Configurables are entities that came up in my research. They have ConfigClass attributes, but don't have run methods, so they're not technically tasks. They end up being values of config fields, which is why I ended up having to support them. I don't have an example off the top of my head. It may be that they won't get used in the future, in which case it'll be easy to drop that section in the future.

            Yes, your intuition is right on why I went with an indices section rather than putting this page front and centre. Perhaps the time is right to just build out the structure of the Processing and Frameworks sections of the docs. After all, we can start populating these docs if we don't have the starting points.

            I might prefer to do that after I finish integrating docs builds with scons and the stack-os-matrix job so that development is a bit more straightforward.

            Show
            jsick Jonathan Sick added a comment - Configurables are entities that came up in my research. They have ConfigClass attributes, but don't have run methods, so they're not technically tasks. They end up being values of config fields, which is why I ended up having to support them. I don't have an example off the top of my head. It may be that they won't get used in the future, in which case it'll be easy to drop that section in the future. Yes, your intuition is right on why I went with an indices section rather than putting this page front and centre. Perhaps the time is right to just build out the structure of the Processing and Frameworks sections of the docs. After all, we can start populating these docs if we don't have the starting points. I might prefer to do that after I finish integrating docs builds with scons and the stack-os-matrix job so that development is a bit more straightforward.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              John Swinbank
              Watchers:
              John Swinbank, Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: