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

Stack API documentation

    XMLWordPrintable

    Details

    • Epic Name:
      sqre-f16-doc-pipe-1
    • Story Points:
      20
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Fall 2016

      Description

      Stack API Doc generation -> pipelines.lsst.io

      Deliverables:

      • a proof of concept of a CI-driven API doc build
      • documentation content planning

        Attachments

          Issue Links

          Stories in Epic (Custom Issue Matrix)

            Activity

            No builds found.
            frossie Frossie Economou created issue -
            frossie Frossie Economou made changes -
            Field Original Value New Value
            Cycle Fall 2016 [ 10803 ]
            Description
            Stack API Doc generation -> pipelines.lsst.io
            Stack API Doc generation -> pipelines.lsst.io
            frossie Frossie Economou made changes -
            Story Points 16 20
            frossie Frossie Economou made changes -
            Epic Child DM-6059 [ 24387 ]
            frossie Frossie Economou made changes -
            Epic Child DM-5195 [ 22910 ]
            frossie Frossie Economou made changes -
            Link This issue relates to DM-5646 [ DM-5646 ]
            Hide
            frossie Frossie Economou added a comment -

            Backlog epic link

            Show
            frossie Frossie Economou added a comment - Backlog epic link
            frossie Frossie Economou made changes -
            WBS 1.02C.10.02
            jsick Jonathan Sick made changes -
            Epic Child DM-6618 [ 25454 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6619 [ 25455 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6648 [ 25489 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6655 [ 25496 ]
            jsick Jonathan Sick made changes -
            Component/s Stack Documentation and UX [ 12880 ]
            jsick Jonathan Sick made changes -
            Labels pipelines-docs
            jsick Jonathan Sick made changes -
            Epic Child DM-7094 [ 26141 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7095 [ 26144 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7096 [ 26145 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6618 [ 25454 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6648 [ 25489 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6655 [ 25496 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7097 [ 26146 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7124 [ 26186 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7125 [ 26187 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-2948 [ DM-2948 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7125 [ 26187 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Link This issue is cloned by DM-7500 [ DM-7500 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4619 [ 21858 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7885 [ 27212 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-7896 [ DM-7896 ]
            Hide
            jsick Jonathan Sick added a comment -

            meas_extensions_convolved is an ideal prototype package for demonstrating task documentation in the new Sphinx documentation.

            Show
            jsick Jonathan Sick added a comment - meas_extensions_convolved is an ideal prototype package for demonstrating task documentation in the new Sphinx documentation.
            frossie Frossie Economou made changes -
            Description Stack API Doc generation -> pipelines.lsst.io Stack API Doc generation -> pipelines.lsst.io

            Deliverable is a proof of concept of a CI-driven API doc build
            frossie Frossie Economou made changes -
            Description Stack API Doc generation -> pipelines.lsst.io

            Deliverable is a proof of concept of a CI-driven API doc build
            Stack API Doc generation -> pipelines.lsst.io

            Deliverables:

            * a proof of concept of a CI-driven API doc build
            * documentation content planning
            jsick Jonathan Sick made changes -
            Epic Child DM-8671 [ 28431 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6059 [ 24387 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4619 [ 21858 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5195 [ 22910 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6619 [ 25455 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7097 [ 26146 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-7885 [ 27212 ]
            jsick Jonathan Sick made changes -
            Reviewers Frossie Economou [ frossie ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Hide
            frossie Frossie Economou added a comment -

            I have reviewed the work done against the deliverables of this epic. This is the status:

            • Documentation content planning was delivered through the release of https://dmtn-030.lsst.io - consult that document for the details of the plan.
            • Regarding the additional deliverable of a proof-of-concept CI-driven API doc build: As part of working on the plan outlined in DMTN-030 with the pipelines team, it was decided to fully integrate the Sphinx documentation build with our scons usage. DM-8671 intended to prototype Jenkins-based pipelines.lsst.io builds using a mechanism in ltd-mason documented in https://sqr-006.lsst.io/#ltd-mason-for-multi-repository-eups-documentation-projects. Hence we are abandoning the planned ltd-mason deliverable, and building the new scons-based approach as new scope in a future epic.
            Show
            frossie Frossie Economou added a comment - I have reviewed the work done against the deliverables of this epic. This is the status: Documentation content planning was delivered through the release of https://dmtn-030.lsst.io - consult that document for the details of the plan. Regarding the additional deliverable of a proof-of-concept CI-driven API doc build: As part of working on the plan outlined in DMTN-030 with the pipelines team, it was decided to fully integrate the Sphinx documentation build with our scons usage. DM-8671 intended to prototype Jenkins-based pipelines.lsst.io builds using a mechanism in ltd-mason documented in https://sqr-006.lsst.io/#ltd-mason-for-multi-repository-eups-documentation-projects . Hence we are abandoning the planned ltd-mason deliverable, and building the new scons-based approach as new scope in a future epic.
            frossie Frossie Economou made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            frossie Frossie Economou made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              frossie Frossie Economou
              Reviewers:
              Frossie Economou
              Watchers:
              Frossie Economou, Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.