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

Automatically version installation documentation for pipelines.lsst.io

    Details

      Description

      This ticket implements a set of tooling in documenteer that allows us to rendering installation documentation in pipelines.lsst.io that is exactly appropriate for the EUPS tag of the stack being documented. Some examples of functionality are:

      • Include the right EUPS tag in the eups distrib install documentation line.
      • Reference the right Python/Conda dependency files for the EUPS tag
      • Populate the version labels throughout the documentation.

      Inside the stack documentation build container we can use the EUPS_TAG environment variable. (https://github.com/lsst-sqre/jenkins-dm-jobs/blob/master/pipelines/lib/util.groovy#L1155)

      An alternative would be to use the EUPS APIs to figure out what tag is currently installed (this might be useful for local builds by developers, but in that case perhaps it would be better have some sort of default fallback).

        Attachments

          Activity

          Show
          jsick Jonathan Sick added a comment - Hey Simon Krughoff , what do you think of this? See https://pipelines.lsst.io/v/DM-17065/  and  https://github.com/lsst/pipelines_lsst_io/pull/112
          Hide
          krughoff Simon Krughoff added a comment -

          Looks great.

          Show
          krughoff Simon Krughoff added a comment - Looks great.
          Hide
          swinbank John Swinbank added a comment -

          Awesome! Thanks Jonathan Sick!

          Show
          swinbank John Swinbank added a comment - Awesome! Thanks Jonathan Sick !
          Hide
          jsick Jonathan Sick added a comment -

          The update is deployed and is working well so far! If you go to a new-is edition like https://pipelines.lsst.io/v/weekly/install/newinstall.html you'll see that the installation instructions point the reader to the tagged version of newinstall and show the right weekly tag in the eups distrib install step.

          Show
          jsick Jonathan Sick added a comment - The update is deployed and is working well so far! If you go to a new-is edition like https://pipelines.lsst.io/v/weekly/install/newinstall.html  you'll see that the installation instructions point the reader to the tagged version of newinstall and show the right weekly tag in the eups distrib install step.
          Hide
          jsick Jonathan Sick added a comment -

          This will appear in documenteer 0.5.0+

          Show
          jsick Jonathan Sick added a comment - This will appear in documenteer 0.5.0+

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Simon Krughoff
              Watchers:
              Gabriele Comoretto, John Swinbank, Jonathan Sick, Joshua Hoblitt, Kian-Tat Lim, Simon Krughoff
            • Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel