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

Improve documentation for how to register metrics with ap_verify

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ap_verify
    • Labels:
      None
    • Story Points:
      2
    • Sprint:
      AP F19-3 (Skipped)
    • Team:
      Alert Production

      Description

      ap_verify's metrics are configured using several MetricsControllerConfigs, but currently this fact is only documented in the command-line reference. Add clearer documentation (perhaps even a full tutorial), delegating to the verify documentation for the details of the actual configuration.

        Attachments

          Activity

          Hide
          krzys Krzysztof Findeisen added a comment -

          Also remove the phrase "defect files and" from the "Packaging data as a dataset" topic page.

          Show
          krzys Krzysztof Findeisen added a comment - Also remove the phrase "defect files and" from the "Packaging data as a dataset" topic page.
          Hide
          krzys Krzysztof Findeisen added a comment -

          Also add an "all the data" example (requested by John Parejko).

          Show
          krzys Krzysztof Findeisen added a comment - Also add an "all the data" example (requested by John Parejko ).
          Hide
          krzys Krzysztof Findeisen added a comment - - edited

          Just noticed that the configs are already documented! Maybe I just need to move the existing page out of the "contributing" docs, and add the requested links...

          Show
          krzys Krzysztof Findeisen added a comment - - edited Just noticed that the configs are already documented ! Maybe I just need to move the existing page out of the "contributing" docs, and add the requested links...
          Hide
          krzys Krzysztof Findeisen added a comment -

          Hi Meredith Rawls, as a future metric-writer, can you take a look and let me know if the documentation is adequate, or whether I was too lazy in how I solved things?

          Show
          krzys Krzysztof Findeisen added a comment - Hi Meredith Rawls , as a future metric-writer, can you take a look and let me know if the documentation is adequate, or whether I was too lazy in how I solved things?
          Hide
          krzys Krzysztof Findeisen added a comment -

          Added a tar file with the built docs, in case it's useful.

          Show
          krzys Krzysztof Findeisen added a comment - Added a tar file with the built docs, in case it's useful.
          Hide
          mrawls Meredith Rawls added a comment -

          Finally looping back on this, thanks for your patience. It looks good, though I am not sure how useful the nominal examples you point to in lsst.verify.gen2tasks.MetricsControllerTask really are. I'll find out eventually, especially if things get gen-3-ified before I dive into metrics! Please see other small comments on GitHub.

          Show
          mrawls Meredith Rawls added a comment - Finally looping back on this, thanks for your patience. It looks good, though I am not sure how useful the nominal examples you point to in lsst.verify.gen2tasks.MetricsControllerTask  really are. I'll find out eventually, especially if things get gen-3-ified before I dive into metrics! Please see other small comments on GitHub.
          Hide
          krzys Krzysztof Findeisen added a comment - - edited

          Thanks for the review! Though if we switch to Gen 3 first, that page and its examples will be obsolete.

          Show
          krzys Krzysztof Findeisen added a comment - - edited Thanks for the review! Though if we switch to Gen 3 first, that page and its examples will be obsolete.

            People

            Assignee:
            krzys Krzysztof Findeisen
            Reporter:
            krzys Krzysztof Findeisen
            Reviewers:
            Meredith Rawls
            Watchers:
            Krzysztof Findeisen, Meredith Rawls
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.