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

          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

            frossie Frossie Economou created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Child DM-23892 [ 432034 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-23886 [ 432022 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-23851 [ 431892 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24608 [ 433942 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24440 [ 433260 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-23996 [ 432451 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25233 [ 435543 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23761 [ 431470 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24958 [ 434872 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23929 [ 428913 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25234 [ 435544 ]
            frossie Frossie Economou made changes -
            Story Points 72
            frossie Frossie Economou made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25331 [ 435727 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25337 [ 435805 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25404 [ 435984 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25405 [ 435985 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-16272 [ 229604 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-12174 [ 34890 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25427 [ 436121 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25439 [ 436160 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25459 [ 436215 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24955 [ 434834 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25616 [ 436414 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25622 [ 436420 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25659 [ 436547 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25660 [ 436548 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25661 [ 436549 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25657 [ 436545 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25690 [ 436603 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25702 [ 436627 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25723 [ 436715 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25740 [ 436742 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25759 [ 436773 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24956 [ 434835 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-24953 [ 434832 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25861 [ 437259 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25900 [ 437338 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25917 [ 437368 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25918 [ 437369 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25973 [ 437477 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25993 [ 437538 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25998 [ 437547 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26001 [ 437552 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26002 [ 437553 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26003 [ 437554 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26137 [ 437916 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26288 [ 438494 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26289 [ 438495 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26291 [ 438503 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26339 [ 438615 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26354 [ 438644 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26527 [ 439071 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26564 [ 439219 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-23929 [ 428913 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25740 [ 436742 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25702 [ 436627 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25759 [ 436773 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26339 [ 438615 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-16272 [ 229604 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26289 [ 438495 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-25404 [ 435984 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-12174 [ 34890 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26354 [ 438644 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26527 [ 439071 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26768 [ 439695 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26826 [ 439790 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26841 [ 439810 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-26975 [ 440161 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-27019 [ 440263 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-27020 [ 440264 ]
            frossie Frossie Economou made changes -
            Link This issue is cloned by DM-27050 [ DM-27050 ]
            frossie Frossie Economou made changes -
            Epic Child DM-27020 [ 440264 ]
            frossie Frossie Economou made changes -
            Epic Child DM-24953 [ 434832 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23761 [ 431470 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25405 [ 435985 ]
            frossie Frossie Economou made changes -
            Epic Child DM-24440 [ 433260 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23996 [ 432451 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25661 [ 436549 ]
            frossie Frossie Economou made changes -
            Epic Child DM-24608 [ 433942 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23851 [ 431892 ]
            frossie Frossie Economou made changes -
            Epic Child DM-26564 [ 439219 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25660 [ 436548 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25337 [ 435805 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25616 [ 436414 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23886 [ 432022 ]
            frossie Frossie Economou made changes -
            Epic Child DM-25622 [ 436420 ]
            frossie Frossie Economou made changes -
            Epic Child DM-23892 [ 432034 ]
            frossie Frossie Economou made changes -
            Status In Progress [ 3 ] In Review [ 10004 ]
            frossie Frossie Economou made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            frossie Frossie Economou made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-27818 [ 442379 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-27818 [ 442379 ]

              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.