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

A Release should also capture the doxygen document under the new Release's Name

    Details

    • Team:
      Architecture

      Description

      When a new Release is generated, the associated doxygen documentation should also be tagged within the web-portal's doxygen document directory and, possibly, also archived in a more permanent location.

        Attachments

          Issue Links

            Activity

            Hide
            gcomoretto Gabriele Comoretto added a comment -

            Just to be sure I am not missing an additional change since both PR and issue have been approved, so no more changes should be done.

            In general, I think that the front documentation page should always point to the latest master. All specific release information should be available in the corresponding page.

             

            Show
            gcomoretto Gabriele Comoretto added a comment - Just to be sure I am not missing an additional change since both PR and issue have been approved, so no more changes should be done. In general, I think that the front documentation page should always point to the latest master. All specific release information should be available in the corresponding page.  
            Hide
            swinbank John Swinbank added a comment -

            Just to be sure I am not missing an additional change since both PR and issue have been approved, so no more changes should be done.

            It is my understanding from the above discussion that https://github.com/lsst/pipelines_lsst_io/blame/17.0.x/index.rst#L68 and https://github.com/lsst/pipelines_lsst_io/blame/17.0.x/index.rst#L99 (these are the “two instances” that Jonathan refers to) both need to be changed before this ticket is complete.

            In general, I think that the front documentation page should always point to the latest master. All specific release information should be available in the corresponding page.

            I think that's a change to how we've done things in the past. I have no particular personal preference as to whether it's a good idea.

            Show
            swinbank John Swinbank added a comment - Just to be sure I am not missing an additional change since both PR and issue have been approved, so no more changes should be done. It is my understanding from the above discussion that https://github.com/lsst/pipelines_lsst_io/blame/17.0.x/index.rst#L68 and https://github.com/lsst/pipelines_lsst_io/blame/17.0.x/index.rst#L99 (these are the “two instances” that Jonathan refers to) both need to be changed before this ticket is complete. In general, I think that the front documentation page should always point to the latest master. All specific release information should be available in the corresponding page. I think that's a change to how we've done things in the past. I have no particular personal preference as to whether it's a good idea.
            Hide
            gcomoretto Gabriele Comoretto added a comment -

            Thank you John. I would like to keep doing, for the moment at least, what has been done for the previous releases unless it is clearly a problem.

            However, if in the past we should have updated index.rst at lines 68 and 99 with the official release, I would expect that now those lines should be pointing to the 16.0 documentation packages. But they are pointing to master.

            Show
            gcomoretto Gabriele Comoretto added a comment - Thank you John. I would like to keep doing, for the moment at least, what has been done for the previous releases unless it is clearly a problem. However, if in the past we should have updated index.rst at lines 68 and 99 with the official release, I would expect that now those lines should be pointing to the 16.0 documentation packages. But they are pointing to master.
            Hide
            swinbank John Swinbank added a comment - - edited

            One of those lines did not exist in the v16 release, so it cannot possibly have pointed anywhere.

            The fact the other one pointed to master was a mistake. Please do not repeat the same mistake.

            Show
            swinbank John Swinbank added a comment - - edited One of those lines did not exist in the v16 release, so it cannot possibly have pointed anywhere. The fact the other one pointed to master was a mistake. Please do not repeat the same mistake.
            Hide
            jsick Jonathan Sick added a comment -

            Gabriele Comoretto: the ticket is already "reviewed" and the work is merged, so I don't think there's anything to prevent this from being "Done". From a documentation engineering perspective my short-term focus is on deprecating any need for doxygen.lsst.codes at all, so I'm not particularly concerned about any loose ends here.

            Show
            jsick Jonathan Sick added a comment - Gabriele Comoretto : the ticket is already "reviewed" and the work is merged, so I don't think there's anything to prevent this from being "Done". From a documentation engineering perspective my short-term focus is on deprecating any need for doxygen.lsst.codes at all, so I'm not particularly concerned about any loose ends here.

              People

              • Assignee:
                gcomoretto Gabriele Comoretto
                Reporter:
                robyn Robyn Allsman [X] (Inactive)
                Reviewers:
                John Swinbank, Jonathan Sick
                Watchers:
                Gabriele Comoretto, John Swinbank, Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: