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

Cleanup lsstDebug references in Task docs

    XMLWordPrintable

    Details

    • Story Points:
      2
    • Sprint:
      AP S23-2 (January), AP S23-3 (February)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      Once the lsstDebug mainpage.dox page is converted to reStructuredText, we can make sure all the necessary baseDebug links are fixed in the Task Topic Types that currently exist. Depending on how DM-28968 is done, this ticket might not actually be necessary.

        Attachments

          Issue Links

            Activity

            No builds found.
            Parejkoj John Parejko created issue -
            Parejkoj John Parejko made changes -
            Field Original Value New Value
            Link This issue is blocked by DM-28968 [ DM-28968 ]
            Parejkoj John Parejko made changes -
            Description Once the lsstDebug {{mainpage.dox}} page is converted to doxygen, we can make sure all the necessary baseDebug links are fixed in the Task Topic Types that currently exist. Depending on how DM-28968 is done, this ticket might not actually be necessary. Once the lsstDebug {{mainpage.dox}} page is converted to reStructuredText, we can make sure all the necessary baseDebug links are fixed in the Task Topic Types that currently exist. Depending on how DM-28968 is done, this ticket might not actually be necessary.
            Parejkoj John Parejko made changes -
            Labels PairCoding ap-training
            Parejkoj John Parejko made changes -
            Watchers John Parejko, Sam Quist [ John Parejko, Sam Quist ] Eric Bellm, Ian Sullivan, John Parejko, Sam Quist [ Eric Bellm, Ian Sullivan, John Parejko, Sam Quist ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-35939 [ DM-35939 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-25882 [ DM-25882 ]
            Parejkoj John Parejko made changes -
            Labels PairCoding ap-training PairCoding ap-training documentation
            sullivan Ian Sullivan made changes -
            Assignee Brianna Smart [ JIRAUSER20419 ]
            sullivan Ian Sullivan made changes -
            Link This issue is cloned by DM-37165 [ DM-37165 ]
            sullivan Ian Sullivan made changes -
            Link This issue is cloned by DM-37165 [ DM-37165 ]
            sullivan Ian Sullivan made changes -
            Parent Issue DM-16824 [ DM-16824 ] DM-36008 [ DM-36008 ]
            sullivan Ian Sullivan made changes -
            Parent DM-36008 [ 1997424 ]
            Urgent? off
            Issue Type Technical task [ 10002 ] Story [ 10001 ]
            sullivan Ian Sullivan made changes -
            Epic Link DM-36522 [ 2254239 ]
            Sprint AP S23-1 (December) [ 1202 ]
            Story Points 2
            Team Alert Production [ 10300 ]
            Watchers Eric Bellm, Ian Sullivan, John Parejko, Sam Quist [ Eric Bellm, Ian Sullivan, John Parejko, Sam Quist ] Eric Bellm, Ian Sullivan, John Parejko [ Eric Bellm, Ian Sullivan, John Parejko ]
            sullivan Ian Sullivan made changes -
            Rank Ranked lower
            sullivan Ian Sullivan made changes -
            Sprint AP S23-1 (December) [ 1202 ] AP S23-2 (January) [ 1209 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked lower
            sullivan Ian Sullivan made changes -
            Sprint AP S23-2 (January) [ 1209 ] AP S23-3 (February) [ 1218 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked lower
            sullivan Ian Sullivan made changes -
            Sprint AP S23-3 (February) [ 1218 ] AP S23-2 (January) [ 1209 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked higher
            Parejkoj John Parejko made changes -
            Component/s meas_astrom [ 10745 ]
            Hide
            Parejkoj John Parejko added a comment -

            Turns out I lied when we chatted: lsstDebug is available from the root of the doc tree.
            https://pipelines.lsst.io/modules/lsstDebug/index.html

            So, you should be able to link to it directly with :ref:`lsstDebug`. An example is `lsst.meas.astrom.AstrometryTask.rst` in the meas_astrom docs. The Debugging section there should use that `:ref:` syntax, instead of just backticks around lsstDebug. We'll probably want to cleanup those docs a bit more as part of this (e.g. wrap the --debug note at the bottom in double-backticks).

            Show
            Parejkoj John Parejko added a comment - Turns out I lied when we chatted: lsstDebug is available from the root of the doc tree. https://pipelines.lsst.io/modules/lsstDebug/index.html So, you should be able to link to it directly with :ref:`lsstDebug` . An example is `lsst.meas.astrom.AstrometryTask.rst` in the meas_astrom docs. The Debugging section there should use that `:ref:` syntax, instead of just backticks around lsstDebug . We'll probably want to cleanup those docs a bit more as part of this (e.g. wrap the --debug note at the bottom in double-backticks).
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-37674 [ DM-37674 ]
            bsmart Brianna Smart made changes -
            Link This issue relates to DM-37801 [ DM-37801 ]
            bsmart Brianna Smart made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            bsmart Brianna Smart made changes -
            Reviewers John Parejko [ parejkoj ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            sullivan Ian Sullivan made changes -
            Sprint AP S23-2 (January) [ 1209 ] AP S23-2 (January), AP S23-3 (February) [ 1209, 1218 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked higher
            Hide
            Parejkoj John Parejko added a comment -

            Brianna Smart: this is still in review: were there other packages I should look at?

            Show
            Parejkoj John Parejko added a comment - Brianna Smart : this is still in review: were there other packages I should look at?
            Hide
            bsmart Brianna Smart added a comment - - edited

            John Parejko No I just needed you to move it from in review to reviewed. I don't believe I can move it myself, or at least one other time I tried to do it myself it wouldn't let me.

             

            Actually this one will let me mark the review is complete myself. Not sure why I had other ones that wouldn't let me do the same.

            Show
            bsmart Brianna Smart added a comment - - edited John Parejko  No I just needed you to move it from in review to reviewed. I don't believe I can move it myself, or at least one other time I tried to do it myself it wouldn't let me.   Actually this one will let me mark the review is complete myself. Not sure why I had other ones that wouldn't let me do the same.
            bsmart Brianna Smart made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            bsmart Brianna Smart made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

              Assignee:
              bsmart Brianna Smart
              Reporter:
              Parejkoj John Parejko
              Reviewers:
              John Parejko
              Watchers:
              Brianna Smart, Eric Bellm, Ian Sullivan, John Parejko
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.