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

Update log documentations for marking RFC-203 implemented

    Details

    • Type: Improvement
    • Status: Done
    • Priority: Major
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Templates:
    • Story Points:
      9
    • Team:
      Data Facility

      Description

      The log Doxygen documentations need to be updated with the implementation of RFC-203.

        Issue Links

          Activity

          Hide
          hchiang2 Hsin-Fang Chiang added a comment -

          Consider adding something about logging in the Developer Guide, possibly in this ticket or create another ticket.

          Show
          hchiang2 Hsin-Fang Chiang added a comment - Consider adding something about logging in the Developer Guide, possibly in this ticket or create another ticket.
          Hide
          hchiang2 Hsin-Fang Chiang added a comment -

          On a closer look, the Developer Guide seems a more appropriate place than the log Doxygen to add the logging guidelines, as these guidelines are for science pipeline developers to use logging, not about the full features/documentations/implementations of the log pacakge.
          Also, log has been used by qserv but how they use it is beyond the scope of RFC-203.
          For example, logging usage in Python is differernt for science pipeline and qserv.

          Show
          hchiang2 Hsin-Fang Chiang added a comment - On a closer look, the Developer Guide seems a more appropriate place than the log Doxygen to add the logging guidelines, as these guidelines are for science pipeline developers to use logging, not about the full features/documentations/implementations of the log pacakge. Also, log has been used by qserv but how they use it is beyond the scope of RFC-203 . For example, logging usage in Python is differernt for science pipeline and qserv .
          Hide
          hchiang2 Hsin-Fang Chiang added a comment -

          Jonathan Sick may you please review this addition to the Developer Guide, as well as the removal of the limbo warning in the log Doxygen for before RFC-203 got approved?

          Originally I wanted to add the example code (tracing.py) to the log package in its examples/ folder, and include the example in the Developer Guide. Is there cross-package referencing I should use?

          I'm not sure about the policy regarding editting the Developer Guide; should Kian-Tat Lim also be included as a reviewer?

          Show
          hchiang2 Hsin-Fang Chiang added a comment - Jonathan Sick may you please review this addition to the Developer Guide, as well as the removal of the limbo warning in the log Doxygen for before RFC-203 got approved? Originally I wanted to add the example code (tracing.py) to the log package in its examples/ folder, and include the example in the Developer Guide. Is there cross-package referencing I should use? I'm not sure about the policy regarding editting the Developer Guide; should Kian-Tat Lim also be included as a reviewer?
          Hide
          ktl Kian-Tat Lim added a comment -

          Most of the Developer Guide can be edited like any other documentation: 1) freely, 2) with review if thought appropriate, and 3) with an RFC if anything is likely to be controversial. Certain marked parts of the Developer Guide (generally ones that say "SHALL" or "MUST") 4) must be explicitly approved by me first. This ticket appears to fall into the first category.

          Show
          ktl Kian-Tat Lim added a comment - Most of the Developer Guide can be edited like any other documentation: 1) freely, 2) with review if thought appropriate, and 3) with an RFC if anything is likely to be controversial. Certain marked parts of the Developer Guide (generally ones that say "SHALL" or "MUST") 4) must be explicitly approved by me first. This ticket appears to fall into the first category.
          Hide
          jsick Jonathan Sick added a comment -

          Thanks Hsin-Fang Chiang, I’ll do a review over lunch. Looks great on first glance.

          A couple notes:

          • I think that eventually a lot of the practical Stack-centric developer documentation from the Developer Guide will end up in the Pipelines documentation. I have no problem at all including this in the Developer Guide now for usability, but once https://pipelines.lsst.io is fully realized, we’ll do some refactoring of content like this.
          • Yeah, there isn’t a way to do literalincludes across Git repos (or against any URL) yet. I’ll probably have to build this, thanks for the reminder.
          Show
          jsick Jonathan Sick added a comment - Thanks Hsin-Fang Chiang , I’ll do a review over lunch. Looks great on first glance. A couple notes: I think that eventually a lot of the practical Stack-centric developer documentation from the Developer Guide will end up in the Pipelines documentation. I have no problem at all including this in the Developer Guide now for usability, but once https://pipelines.lsst.io is fully realized, we’ll do some refactoring of content like this. Yeah, there isn’t a way to do literalincludes across Git repos (or against any URL) yet. I’ll probably have to build this, thanks for the reminder.
          Hide
          jsick Jonathan Sick added a comment -

          Looks great and is well written. PR contains a few suggested improvements before merging.

          Show
          jsick Jonathan Sick added a comment - Looks great and is well written. PR contains a few suggested improvements before merging.
          Hide
          hchiang2 Hsin-Fang Chiang added a comment -

          Jonathan Sick thank you very much for your detailed review and thoughtful feedbacks! Suggestions are incorporated and it's now merged.

          Show
          hchiang2 Hsin-Fang Chiang added a comment - Jonathan Sick thank you very much for your detailed review and thoughtful feedbacks! Suggestions are incorporated and it's now merged.

            People

            • Assignee:
              hchiang2 Hsin-Fang Chiang
              Reporter:
              hchiang2 Hsin-Fang Chiang
              Reviewers:
              Jonathan Sick
              Watchers:
              Hsin-Fang Chiang, Jonathan Sick, Kian-Tat Lim
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development