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

Draft Pipelines Documentation Implementation Plan technote

    XMLWordPrintable

    Details

      Description

      This technote will present an implementation plan for implementing the Science Pipelines documentation site based:

      • Initial experience migrating the LSST Stack’s documentation from doxygen to sphinx (see 7094 and DM-7095).
      • Pipelines documentation sprint meeting with Science Pipelines representatives, held December 6-9, 2016.

      This technote will also cover initial plans for content strategy.

        Attachments

          Issue Links

          duplicates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7124 Map structure of Science Pipelines codebase and Tasks

          • Won't Fix
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7094 Develop Sphinx configuration for Pipelines Documentation, including MVP HTML/CSS Template

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7095 Pilot Sphinx/Breath/Doxygen-generated API docs for daf_base

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            See seed discussion at https://community.lsst.org/t/pipelines-documentation-site-organization-sketch/1088?u=jsick

            Show
            jsick Jonathan Sick added a comment - See seed discussion at https://community.lsst.org/t/pipelines-documentation-site-organization-sketch/1088?u=jsick
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Created the pipelines documentation sprint meeting agenda at https://confluence.lsstcorp.org/display/DM/Science+Pipelines+Doc+Sprint+2016-12, including deliverables from the meeting and initial discussion points.

            Show
            jsick Jonathan Sick added a comment - Created the pipelines documentation sprint meeting agenda at https://confluence.lsstcorp.org/display/DM/Science+Pipelines+Doc+Sprint+2016-12 , including deliverables from the meeting and initial discussion points.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            https://dmtn-030.lsst.io/v/DM-7096

            This is just a cursory review; I hope to close this by Dec 31. I think DMTN-030 will continue to evolve and be a living document for us. Major changes and additions that we identify now can be put into future tickets.

            Show
            jsick Jonathan Sick added a comment - https://dmtn-030.lsst.io/v/DM-7096 This is just a cursory review; I hope to close this by Dec 31. I think DMTN-030 will continue to evolve and be a living document for us. Major changes and additions that we identify now can be put into future tickets.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Published to https://dmtn-030.lsst.io/v/v1 and archived to https://zenodo.org/record/228174

            Show
            jsick Jonathan Sick added a comment - Published to https://dmtn-030.lsst.io/v/v1 and archived to https://zenodo.org/record/228174
            Hide
            Permalink
            krughoff Simon Krughoff added a comment -

            Jonathan Sick This looks very good to me. Sorry I didn't get a chance to comment last week.

            Show
            krughoff Simon Krughoff added a comment - Jonathan Sick This looks very good to me. Sorry I didn't get a chance to comment last week.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              John Swinbank, Mandeep Gill [X] (Inactive), Simon Krughoff
              Watchers:
              John Swinbank, Jonathan Sick, Mandeep Gill [X] (Inactive), Simon Krughoff
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.