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

Documentation Engineering and Search

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Epic Name:
      sqre-f20-doceng-1
    • Story Points:
      72
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Fall 2020

      Description

      This epic includes:

      • Taking the search prototype into production
      • Science pipelines work including Doxygen and conda build integration
      • Defining an architectural approach to documentation testing

        Attachments

          Issue Links

          is cloned by

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. DM-27050 Documentation Engineering and lsst.io theming

          • Done

          Stories in Epic (Custom Issue Matrix)

          Key Summary Story Points Assignee Status
           
          		DM-26975

          Ingest SCTR into www.lsst.io search

          		 0.7 Jonathan Sick Done
           
          		DM-27019

          Delete OPSTN series

          		 0.5 Jonathan Sick Done
           
          		DM-26768

          Unpin Documenteer's sphinx extensions and test against representative downstream users

          		 1.8 Jonathan Sick Done
           
          		DM-26841

          Update documenteer's doxygen configuration to encompass base configs

          		 7.7 Jonathan Sick Done
           
          		DM-26826

          Fix docstring See also references in afw and ip_isr

          		 0.5 Jonathan Sick Done
           
          		DM-25331

          Support change controlled docs and test reports with templates and templatebot

          		 4.2 Jonathan Sick Done
           
          		DM-26137

          Explain that www.lsst.io is for technical documentation

          		 1.7 Jonathan Sick Done
           
          		DM-26291

          Fix URL redirects on the document series pages (www.lsst.io)

          		 1 Jonathan Sick Done
           
          		DM-26288

          Upgrade documenteer with GitHub Actions, pre-commit linting, black formatting

          		 4.2 Jonathan Sick Done
           
          		DM-25861

          Switch to CSS custom properties-based design system for www.lsst.io

          		 3.5 Jonathan Sick Done
           
          		DM-25900

          New Community "Statistics Q&A" subcategory in "Science"

          		 0.2 Jonathan Sick Done
           
          		DM-26003

          Post-release cleanup of www.lsst.io codebase

          		 3 Jonathan Sick Done
           
          		DM-26002

          Finish refinement breadcrumb/clearing UI in www.lsst.io

          		 2.4 Jonathan Sick Done
           
          		DM-26001

          Fix buttons in www.lsst.io to use the correct pointer

          		 0.5 Jonathan Sick Done
           
          		DM-25998

          Add funding notice to www.lsst.io

          		 0.3 Jonathan Sick Done
           
          		DM-25993

          Add disclaimer about content in www.lsst.io search

          		 0.4 Jonathan Sick Done
           
          		DM-25690

          www.lsst.io: Create category pages for document series

          		 3.3 Jonathan Sick Done
           
          		DM-25723

          Update ook index schema to enable sorting

          		 3.2 Jonathan Sick Done
           
          		DM-25459

          Write Vault secrets how-to docs for Roundtable developers

          		 3 Jonathan Sick Done
           
          		DM-25439

          Clean title, other inputs, from sqrbot-jr project create

          		 0.7 Jonathan Sick Done
           
          		DM-25427

          Update Roundtable/Safir apps to use aiokafka 0.6.0

          		 1 Jonathan Sick Done
           
          		DM-25973

          Use gatsby-plugin-canonical-urls

          		 2.8 Jonathan Sick Done
           
          		DM-25918

          Add listing of user guides to www.lsst.io

          		 5.5 Jonathan Sick Done
           
          		DM-25917

          Diagnose and fix Ook ingest failures

          		 3.5 Jonathan Sick Done
           
          		DM-25657

          Revise lsst doc LaTeX template: name and README

          		 2.3 Jonathan Sick Done
           
          		DM-25659

          Additional validation for the general-purpose LaTeX document template in sqrbot-jr / templatebot

          		 2.1 Jonathan Sick Done
           
          		DM-24958

          Deploy Ook to Roundtable

          		 2.5 Jonathan Sick Done
           
          		DM-24955

          Query links result in infinite redirects

          		 2.1 Jonathan Sick Done
           
          		DM-25234

          Remove the CI link from the LSST the Docs dashboard pages (LTD Dasher)

          		 1 Jonathan Sick Done
           
          		DM-25233

          Migrate technote templates to GitHub Actions

          		 3.2 Jonathan Sick Done
           
          		DM-24956

          Empty search should probably return no results

          		 Jonathan Sick Invalid

            Activity

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.