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

Document template for EUPS Stack packages in developer guide

    XMLWordPrintable

    Details

      Description

      The package template, https://github.com/lsst/template should be discussed in the developer guide. See also DM-7140 for documentation of dependency tracking, specifically.

      A related idea, which would make the docs easier to write, is to turn the template repo into a cookiecutter project (this would be technically straightforward).

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11513 Prototype system for publishing templates of package documentation

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7097 Develop README, CONTRIBUTING templates for stack packages

          • Won't Fix

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7140 Document dependency tracking for EUPS Packages in Developer Guide

          • Invalid

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            As a part of this, the readme in the template product is not very helpful and should be updated as well.

            Show
            Parejkoj John Parejko added a comment - As a part of this, the readme in the template product is not very helpful and should be updated as well.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            John Parejko: you’re in luck, there’s also a ticket on the backlog for that: DM-7097.

            Show
            jsick Jonathan Sick added a comment - John Parejko : you’re in luck, there’s also a ticket on the backlog for that: DM-7097 .
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            Well unbacklog them!

            Actually, it sounds like 7097 is about a template README.md, while I'm asking for the template product's readme to be helpful when using that product to create a new product.

            Show
            Parejkoj John Parejko added a comment - Well unbacklog them! Actually, it sounds like 7097 is about a template README.md, while I'm asking for the template product's readme to be helpful when using that product to create a new product.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            With DM-11513 and RFC-376, this ticket can proceed in the vein of creating a cookiecutter project a stack package in the lsst/templates repo. The templates repo provides a structure for documenting templates too.

            Show
            jsick Jonathan Sick added a comment - With DM-11513 and RFC-376 , this ticket can proceed in the vein of creating a cookiecutter project a stack package in the lsst/templates repo. The templates repo provides a structure for documenting templates too.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            I think that other tickets have effectively caught us up on this front. https://github.com/lsst/templates/tree/master/project_templates/stack_package

            Show
            jsick Jonathan Sick added a comment - I think that other tickets have effectively caught us up on this front.  https://github.com/lsst/templates/tree/master/project_templates/stack_package

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              John Parejko, Jonathan Sick
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.