Details
-
Type:
Story
-
Status: Invalid
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Epic Link:
-
Team:SQuaRE
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
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link |
|
| Description |
The package template, https://github.com/lsst/template should be discussed in the developer guide. See also Possibly related idea is to turn the template repo into a cookiecutter project (this would be technically straightforward; would require an RFC, though). |
The package template, https://github.com/lsst/template should be discussed in the developer guide. See also 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). |
John Parejko: you’re in luck, there’s also a ticket on the backlog for that: DM-7097. 
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.
| Labels | dm-dev-guide |
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.
I think that other tickets have effectively caught us up on this front. https://github.com/lsst/templates/tree/master/project_templates/stack_package
| Resolution | Done [ 10000 ] | |
| Status | To Do [ 10001 ] | Invalid [ 11005 ] |
As a part of this, the readme in the template product is not very helpful and should be updated as well.