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

Stack documentation infrastructure and migration

    Details

    • Epic Name:
      doc-implement-tools
    • Story Points:
      63
    • WBS:
      02C.01.02
    • Team:
      SQuaRE
    • Cycle:
      Winter 2016

      Description

      [Epic retitled and bumped in points to reflect wider scope and change in resource allocation]

      This epic containes work on migrating the documentation infrastructure
      into sphinx (from doxygen, Confluence) subject to RFC, continuous deployment of documentation, read-the-docs or
      similar presentation, standardisation via teplates of common
      information, a proposal for CI-ing examples and tutorials, release and install note documentation, and visual
      design and javascript development for UI/UX

      An additional request to migrate Word-based design documentation has been accepted. LaTeX support is being investigated.

      [JS 100%]

        Attachments

          Issue Links

          Stories in Epic (Custom Issue Matrix)

          Key Summary Story Points Assignee Status
           
          DM-4724

          Implement zenodio.harvest

          2.5 Jonathan Sick Done
           
          DM-4600

          Fix publication domain in all existing technotes

          Jonathan Sick Done
           
          DM-4599

          Fix publication URL in technote bootstrap to lsst.io

          Jonathan Sick Done
           
          DM-4900

          Generate Doxygen XML output via sconsUtils

          0.1 Jonathan Sick Done
           
          DM-4815

          Planning for Software Documentation Deployment Service

          3.5 Jonathan Sick Done
           
          DM-4793

          Refactor prototype docs into “Developer Guide” and Science Pipelines doc projects

          3 Jonathan Sick Done
           
          DM-4951

          Add S3/Route53 project provisioning capabilities to ltd-keeper

          2.5 Jonathan Sick Done
           
          DM-4950

          Build MVP of ltd-keeper web app covering ltd-mason interface

          13.5 Jonathan Sick Done
           
          DM-5100

          Docs for ltd-keeper

          1 Jonathan Sick Done
           
          DM-4351

          Write technote on the new technical note platform

          5.5 Jonathan Sick Done
           
          DM-4324

          Bootstrap for new Sphinx/reST/RTD technical reports

          2 Jonathan Sick Done
           
          DM-4256

          Sphinx support of sqr-001 technical note

          1 Jonathan Sick Done
           
          DM-4376

          Learn and setup nebula as a development machine

          1.5 Jonathan Sick Done
           
          DM-4196

          Build ltd-mason for running a multi-package software documentation build

          17 Jonathan Sick Done
           
          DM-4195

          Build proof-of-concept package documentation for lsst.afw

          2.2 Jonathan Sick Done
           
          DM-4220

          Convert copyright/license statements to one-liners for RFC-45

          7.5 Jonathan Sick Done
           
          DM-4143

          Demonstrate using Breathe for Python & C++ API reference in New Docs

          3 Jonathan Sick Done
           
          DM-4142

          Discover how to create Doxygen XML in build system

          1.5 Jonathan Sick Done
           
          DM-4117

          Clean up lsst_stack_docs for preview

          0.5 Jonathan Sick Done
           
          DM-3924

          Centralize Sphinx configuration for Design Documents

          1.5 Jonathan Sick Done
           
          DM-3814

          Migrate LDM-152 to reST Design Doc Platform

          1 Jonathan Sick Done
           
          DM-3813

          Build a DM Design Document Platform on GitHub with CI

          Jonathan Sick Done
           
          DM-3808

          Setup lsst_sphinx_kit package structure

          0.5 Jonathan Sick Done
           
          DM-3863

          Web design fixes DM Design Documents on Sphinx/Read The Docs

          2 Jonathan Sick Done
           
          DM-3836

          Migrate LDM-129 to new design docs platform

          2 Jonathan Sick Done
           
          DM-3835

          Migrate LDM-135 to new design docs platform

          4.5 Jonathan Sick Done
           
          DM-3834

          Migrate LDM-230 to new docs platform

          1.5 Jonathan Sick Done
           
          DM-3914

          Continuous Deployment of the LDM-151 DM Applications Design to GitHub Pages with Travis CI

          Jonathan Sick Won't Fix
           
          DM-3807

          Build documenteer package to support stack documentation

          Jonathan Sick Invalid

            Activity

            There are no comments yet on this issue.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                frossie Frossie Economou
                Watchers:
                Frossie Economou
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel