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

Analyze and expand on requirements for documentation examples and testing from DMTN-085 in SQR-032 technote

    Details

      Description

      The QA Strategy Working Group, in https://dmtn-085.lsst.io, produced three recommendations related to documentation examples and testing:

      • QAWG-REC-13: "Provide a central location where examples, scripts and utilities which are not fundamental to pipeline execution are indexed and made discoverable"
      • QAWG-REC-14: "The Project should adopt a documented (in the Developer Guide) policy on the maintenance of example code"
      • QAWG-REC-15: "The
        *Project should prioritize the development of a documentation system which makes it convenient to include code examples and that tests those examples as part of a documentation build"

      As a first step towards implementing these recommendations, we need to analyze them and expand them into concrete technical requirements to guide future development. This will be done in a new technote, https://sqr-032.lsst.io.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            This is the initial draft of the documentation testing technote: https://sqr-032.lsst.io/v/DM-20511 If you have any comments, I'd appreciate them on the PR at https://github.com/lsst-sqre/sqr-032/pull/2

            Show
            jsick Jonathan Sick added a comment - This is the initial draft of the documentation testing technote: https://sqr-032.lsst.io/v/DM-20511  If you have any comments, I'd appreciate them on the PR at  https://github.com/lsst-sqre/sqr-032/pull/2
            Hide
            jsick Jonathan Sick added a comment -

            Approval from Frossie Economou and now sending out for feedback.

            Show
            jsick Jonathan Sick added a comment - Approval from Frossie Economou and now sending out for feedback.

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: